Package Exports
- @leverageaiapps/locus-beta
- @leverageaiapps/locus-beta/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@leverageaiapps/locus-beta) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@leverageaiapps/locus-ssh
SSH-mode version of Locus - Forward terminal without ANSI codes. Clean output for AI processing.
Features
- 🚀 Instant Setup - One command to start forwarding your terminal
- 📱 Mobile Access - Access your terminal from any device with a browser
- 🎙️ Voice Input - Built-in voice recognition for hands-free coding
- 🔒 Secure - PIN-protected sessions with automatic IP blocking
- 🌐 No Port Forwarding - Uses Vortex Gateway for secure tunneling
- ⚡ Real-time - WebSocket-based communication for instant feedback
- 🎯 PTY Support - Full terminal emulation with node-pty
Prerequisites
Locus requires Node.js 18 or higher. The Vortex tunnel is built-in and requires no additional dependencies.
Installation
npm install -g @leverageaiapps/locusVerify Installation:
locus --versionQuick Start
# Start a terminal session
locus
# Start with a specific command
locus claude
locus python
locus vimA QR code will appear - scan it with your phone and enter the 6-digit PIN to access your terminal!
Usage
Basic Commands
# Start a terminal session
locus
# Start with a custom PIN
locus --pin 123456
# Start with a machine name
locus --name "My Laptop"
# Start a specific command with PIN
locus claude --pin 123456Options
| Option | Short | Description |
|---|---|---|
--name <name> |
-n |
Set a custom machine name |
--pin <pin> |
-p |
Set a custom 6-digit PIN |
--debug-asr |
Enable verbose ASR logging |
Configuration
# Show current configuration
locus config --showHow It Works
- Run
locus [command]in your terminal - Locus starts a local web server and creates a Vortex tunnel
- A QR code appears with your unique URL
- Scan the QR code with your phone
- Enter the 6-digit PIN to access your terminal
- Your terminal is now accessible from your mobile device!
Exiting
To exit Locus, you can:
- Type
exitin the terminal (or the command to exit your current program) - Press
Ctrl+Cin the terminal where you ranlocus - Close the terminal window
When you see "Terminal session ended.", the session has been successfully closed.
Security
- PIN Protection: Each session requires a 6-digit PIN
- Rate Limiting: Max 10 failed login attempts per IP
- Auto-blocking: IPs are temporarily blocked after too many failures
- Session Cookies: Authentication persists for 24 hours
Troubleshooting
Error: posix_spawnp failed
Fix permissions on the node-pty spawn-helper:
# macOS ARM (M1/M2/M3)
chmod +x node_modules/node-pty/prebuilds/darwin-arm64/spawn-helper
# macOS Intel
chmod +x node_modules/node-pty/prebuilds/darwin-x64/spawn-helper
# Linux x64
chmod +x node_modules/node-pty/prebuilds/linux-x64/spawn-helperConnection Issues
If you encounter connection issues, verify the Vortex gateway is accessible:
curl -I https://vortex.futuretech.social/healthContributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Vortex Gateway for secure WebSocket tunneling
- node-pty for PTY support
- xterm.js for terminal emulation in the browser