Skip to main content

​
Synopsis

jarvis [OPTIONS]

​
Description

Jarvis is a GPU-accelerated terminal emulator with AI integration. It combines a modern terminal with an AI assistant, tiling window management, and social features.

​
Options

​
-e, --execute
string
Execute a command instead of the default shell.Example:
jarvis --execute "npm run dev"
jarvis -e htop
The command is passed to the shell exactly as specified. Use quotes if the command contains spaces or special characters.
​
-d, --directory
string
Working directory to start in.Example:
jarvis --directory ~/projects/my-app
jarvis -d /tmp
If not specified, Jarvis starts in the current working directory. Supports ~ expansion.
​
--config
string
Config file path override.Example:
jarvis --config ~/.jarvis-custom.toml
jarvis --config /etc/jarvis.toml
By default, Jarvis loads configuration from:
  • macOS: ~/Library/Application Support/jarvis/config.toml
  • Linux: ~/.config/jarvis/config.toml
  • Windows: %APPDATA%\jarvis\config.toml
​
--log-level
string
Log level override.Valid values:
  • debug — Verbose debug information
  • info — Informational messages (default)
  • warn — Warnings only
  • error — Errors only
Example:
jarvis --log-level debug
jarvis --log-level error
Overrides the logging.level setting in config.toml.
​
-h, --help
Print help information.Example:
jarvis --help
​
-V, --version
Print version information.Example:
jarvis --version

​
Examples

​
Basic Usage

Start Jarvis with default settings: 
jarvis

​
Run a Specific Command

Open Jarvis and immediately run a command: 
# Monitor system resources
jarvis --execute htop

# Start a development server
jarvis -e "npm run dev"

# Run a Python script
jarvis -e "python app.py"

​
Start in a Specific Directory

Open Jarvis in a project directory: 
jarvis --directory ~/projects/my-app
jarvis -d /var/log

​
Combined Options

Combine multiple options: 
# Start in a directory and run a command
jarvis -d ~/projects/my-app -e "npm test"

# Use custom config with debug logging
jarvis --config ~/.jarvis-dev.toml --log-level debug

​
Custom Configuration

Use a non-default config file: 
# Development config
jarvis --config ~/.jarvis-dev.toml

# Production config
jarvis --config /etc/jarvis/production.toml

​
Debug Mode

Run with verbose logging for troubleshooting: 
jarvis --log-level debug

​
Environment Variables

Jarvis respects these environment variables:
​
SHELL
string
Default shell to use if not specified in config.Example:
export SHELL=/bin/zsh
jarvis
​
TERM
string
Terminal type. Jarvis sets this to xterm-256color by default.
​
ANTHROPIC_API_KEY
string
Claude API key (if not in config).Example:
export ANTHROPIC_API_KEY=sk-ant-...
jarvis
​
GOOGLE_API_KEY
string
Gemini API key (if not in config).
​
OPENAI_API_KEY
string
OpenAI API key for Whisper (if not in config).

​
Exit Codes

​
0
Success
Jarvis exited normally.
​
1
Error
General error (config load failed, initialization error, etc.).
​
2
Usage Error
Invalid command-line arguments.

​
Configuration File

For detailed configuration options, see:

​
See Also