https://github.com/pomdtr/tweety
An integrated terminal for your browser
https://github.com/pomdtr/tweety
arc-browser terminal
Last synced: about 1 year ago
JSON representation
An integrated terminal for your browser
- Host: GitHub
- URL: https://github.com/pomdtr/tweety
- Owner: pomdtr
- License: mit
- Created: 2023-05-20T10:36:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T16:23:50.000Z (over 1 year ago)
- Last Synced: 2025-03-31T04:06:42.132Z (about 1 year ago)
- Topics: arc-browser, terminal
- Language: Go
- Homepage:
- Size: 3.84 MB
- Stars: 93
- Watchers: 4
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Tweety - An Integrated Terminal for your Browser
Minimize your context switching by interacting with your terminal directly from your browser.
## Features
### Mix Web and Terminal Tabs
### Side by Side Mode
### Developer-Console Integration
## Installation
Tweety is available on macOS, Linux.
```sh
# Homebrew (recommended)
brew install pomdtr/tap/tweety
```
or download a binary from [releases](https://github.com/pomdtr/tweety/releases).
If you want to compile it yourself, you can use the following command:
```sh
git clone https://github.com/pomdtr/tweety
cd tweety
make install
```
See the `tweety completion` command to generate completion scripts for your shell.
## Usage
```sh
tweety [-p ]
```
By default, tweety will start on port 9999, so you can access it at .
## Browser Extension
Browser extensions for Chrome and Firefox are available in the `extension` folder.
## Chrome Extension
- Clone the repository
- Go to `chrome://extensions`
- Enable `Developer mode`
- Click on `Load unpacked`
- Select the `extension/chrome` folder
By default, the extension will try to connect to `localhost:9999`. You can
customize the origin in the extension options.
## Firefox Extension
- Clone the repository
- Go to `about:debugging
- Click on `This Firefox`
- Click on `Load Temporary Add-on...`
- Select the `extension/firefox/manifest.json` file
## Starting Tweety on Boot
If you have installed Tweety using Homebrew, you can use the following command:
```sh
brew services start tweety
```
To unload the service, use:
```sh
brew services stop tweety
```
## Configuration
Use the `$XDG_CONFIG_DIR/tweety/tweety.json` file to configure Tweety (defaults
to `~/.config/tweety/tweety.json`).
Alternatively, you can use the `TWEETY_CONFIG` environment variable to specify a
custom path.
```json
{
"$schema": "https://github.com/pomdtr/tweety/releases/latest/download/config.schema.json",
"theme": "Tomorrow",
"themeDark": "Tomorrow Night",
"xterm": {
"fontSize": 14,
},
"env": {
"EDITOR": "kak"
},
"defaultProfile": "default",
"profiles": {
"default": {
"command": "bash",
"args": ["--login"],
"env": {
"EDITOR": "vim"
}
},
"fish": {
"command": "fish",
"args": ["--login"],
"favicon": "https://fishshell.com/favicon.ico"
}
}
}
```
The `xterm` section is passed directly to xterm.js, see the [documentation](https://xtermjs.org/docs/api/terminal/interfaces/iterminaloptions/).
## Endpoints
- `/` - open the default profile
- `/?reload=true` - reload the page when the command exits
- `/?profile=` - open a specific profile
## FAQ
### Windows Version?
The [package](https://github.com/creack/pty) used to create the terminal UI does not support Windows.
But it's planned, so stay tuned! In the meantime, you can run tweety from [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).