| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Access your AI coding assistants from any device. Works with Claude Code, Aider, GitHub Copilot, and any terminal-based AI tool.
Previous versions:
Termly CLI includes prebuilt binaries for all platforms - no compilation required!
All Platforms:
npm install -g @termly-dev/cliAfter installation, the termly command is available globally.
That's it! Works out-of-the-box on:
For beta testers and development:
npm install -g @termly-dev/cli-devThis installs the termly-dev command which connects to the development environment.
Node.js 18+ - That's all you need!
Termly CLI uses @lydell/node-pty with prebuilt binaries for all platforms:
Installation typically completes in 10-30 seconds.
Termly CLI supports three environments:
| Environment | Package | Command | Server URL | Use Case |
|---|---|---|---|---|
| Production | @termly-dev/cli | termly | wss://api.termly.dev | End users |
| Development | @termly-dev/cli-dev | termly-dev | wss://dev-api.termly.dev | Beta testers |
| Local | Run from source | TERMLY_ENV=local termly | ws://localhost:3000 | Developers only |
Note: Server URLs are hardcoded per environment and cannot be changed by users.
cd /path/to/your/project
termly startcd /path/to/your/project
termly-dev start# Clone the repo
git clone https://github.com/termly-dev/termly-cli
cd termly-cli
npm install
# Run with local environment
TERMLY_ENV=local node bin/cli.js startRun multiple sessions simultaneously:
# Terminal 1
cd ~/frontend
termly start
# Terminal 2 (new window)
cd ~/backend
termly startEach session:
Manage sessions:
termly status # Show all sessions
termly stop abc-123 # Stop specific session
termly list # Quick listTermly CLI supports 23+ interactive terminal-based AI coding assistants:
And more... - Works with any terminal-based AI tool that supports interactive TTY mode
All commands work the same way in both termly (production) and termly-dev (development).
termly setupInteractive configuration setup (optional - sets default AI tool preference).
termly start [directory] [options]Start a new session with AI tool.
Options:
Examples:
# Auto-detect and start
termly start
# Use Aider explicitly
termly start --ai aider
# Use Claude Code with custom directory
termly start /path/to/project --ai "claude code"
# Pass arguments to AI tool
termly start --ai aider --ai-args "--model gpt-4"
# Continue previous Claude Code session (restore context after restart)
termly start --ai claude-code --ai-args "--continue"termly status [--all]Show all active sessions with detailed information.
termly stop [session-id] [--all]Stop one or all sessions.
termly listQuick list of active sessions with encryption fingerprints for verification.
termly tools list # List available AI tools
termly tools detect # Detect installed tools
termly tools info <tool> # Show tool informationtermly config # Show current configuration
termly config get <key> # Get config value
termly config set <key> <value> # Set config valueExamples:
termly config set defaultAI aider
termly config get defaultAINote: Server URL is determined by environment and cannot be changed via config.
termly cleanupRemove stale sessions (processes that are no longer running).
Installation usually works flawlessly thanks to prebuilt binaries.
If you encounter issues:
"Cannot find module 'node-pty'"
Reinstall the package:
npm uninstall -g @termly-dev/cli
npm cache clean --force
npm install -g @termly-dev/cliPermission errors on macOS/Linux
Use sudo or fix npm permissions:
# Option 1: Use sudo
sudo npm install -g @termly-dev/cli
# Option 2: Fix npm permissions (recommended)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g @termly-dev/cliWindows: "EPERM: operation not permitted"
This is usually a warning, not a fatal error. Check if installation succeeded:
termly --versionIf the command works, installation was successful.
No AI tools detected?
termly tools list # Check what's installedInstall an AI tool:
Session already running?
termly status # Find session ID
termly stop abc-123 # Stop itCheck your environment:
termly config # Shows current environment and server URLLogs: ~/.termly/logs/cli.log
For issues: https://github.com/termly-dev/termly-cli/issues
Termly CLI uses a PTY (pseudo-terminal) to spawn AI tools locally and streams I/O through WebSocket with end-to-end encryption.
Mobile App <--[encrypted]--> WebSocket Server <--[encrypted]--> CLI <--[local]--> PTY <--> AI Tool
Key features:
For detailed architecture diagrams and data flow, see docs/ARCHITECTURE.md.
# Install dependencies
npm install
# Run production mode
node bin/cli.js start
# Run development mode
node bin/cli-dev.js start
# Run local mode (custom server)
TERMLY_ENV=local node bin/cli.js start
# Debug mode
DEBUG=1 node bin/cli.js start --debug
# View logs
tail -f ~/.termly/logs/cli.log # macOS/Linux
Get-Content $env:USERPROFILE\.termly\logs\cli.log -Wait -Tail 50 # Windows# Update version in package.json and package.dev.json
npm version patch # or minor, or major
# Publish production package
npm publish# Use the publish script
./scripts/publish-dev.sh
# Or manually:
cp package.dev.json package.json
npm publish
git checkout package.jsonContributions are welcome! Please:
Before contributing:
MIT - See LICENSE for details
Made with ❤️ by the Termly Team
| Back | FazBrowse Home | New Git URL |