Quick Start

Get remote-terminal running in under 2 minutes.

1. Install

git clone https://github.com/chintan-diwakar/remote-terminal.git
cd remote-terminal
npm install

2. Configure

Create a .env file:

cp .env.example .env

Edit .env with your settings:

# Required for Telegram bot
TELEGRAM_BOT_TOKEN=your-bot-token
TELEGRAM_ALLOWED_USERS=your-user-id

# Optional: For LLM mode
OPENAI_API_KEY=your-openai-key
OPENAI_MODEL=gpt-4.1-nano

Tip: Skip this step if you only need the web terminal.

3. Start

npm start

Or for local development (no Tailscale):

npm run dev

4. Access

What’s Next?

• Set up Telegram Bot
• Configure Tailscale
• Use LLM Mode