eli-oat/tweety

An integrated terminal for your browser

Tweety - An Integrated Terminal for your Browser

Minimize your context switching by interacting with your terminal directly from your browser.

Features

Installation

Tweety is available on macOS, Linux.

# Homebrew (recommended)
brew install pomdtr/tap/tweety

or download a binary from releases.

If you want to compile it yourself, you can use the following command:

git clone https://github.com/pomdtr/tweety
cd tweety
make install

Usage

tweety <entrypoint>

By default, tweety will start on port 9999, so you can access it at http://localhost:9999.

You can use the --host and --port flags to change the host and port:

tweety --host 0.0.0.0 --port 8080 <script-path>

You can pass arguments to your entrypoint script using the cmd query parameter. The provided command will be splitted by the shlex library, then passed as arguments to your entrypoint script.

• http://localhost:9999/?cmd=ssh+example.com will run the command <entrypoint> ssh example.com
• http://localhost:9999/?cmd=nvim+/home/pomdtr/.zshrc will run the command <entrypoint> nvim /home/pomdtr/.zshrc

Make sure to properly parse and validate params in your entrypoint script.

Example entrypoint

#!/usr/bin/env -S deno run -A

import { program } from 'npm:@commander-js/extra-typings'

async function run(command: string, args?: string[]): Promise<number> {
    const cmd = new Deno.Command(command, { args });
    const process = cmd.spawn();
    const status = await process.status;
    return status.code
}

// url: http://localhost:9999/
program.name("tweety").action(async () => {
    await run("fish")
})

// url: http://localhost:9999/?cmd=htop
program.command("htop").action(async () => {
    await run("htop");
})

// url: http://localhost:9999/?cmd=ssh+example.com
program.command("ssh").argument("<host>").action(async (host: string) => {
    await run("ssh", [host]);
})

// url: http://localhost:9999/?cmd=nvim+/path/to/file
program.command("nvim").argument("<file>", "File to open in editor").action(async (file) => {
    await run("nvim", file ? [file] : []);
})

if (import.meta.main) {
    await program.parseAsync();
}