🤵 Jarvis Shell (jarvish)

🌐 日本語版 README はこちら

💡 About

"I want J.A.R.V.I.S. as my companion — but inside my terminal."

Jarvish is a Next Generation AI Integrated Shell written in Rust, inspired by J.A.R.V.I.S. from Marvel's Iron Man. It natively embeds AI intelligence into your everyday shell experience — no more copy-pasting errors into a browser. Just ask Jarvis.

✨ Features

🧠 AI-Powered Assistance

• 💬 Talk to Jarvis in natural language — right from your shell prompt
• 🔍 When a command fails, Jarvis automatically investigates the error using stdout/stderr context
• 🛠️ Jarvis can read and write files, execute commands as an AI agent with tool-calling capabilities

🐟 Fish-like UX

• 🎨 Real-time syntax highlighting as you type
• ⚡ Auto-completion for commands (PATH binaries, builtins) and file paths
• 📜 History-based suggestions powered by reedline

📦 The Black Box

• 🗃️ Every command execution is persisted — command, timestamp, working directory, exit code
• 💾 stdout/stderr outputs are stored in a Git-like content-addressable blob storage (SHA-256 + zstd compression)
• 🔄 Ask Jarvis about "last week's error" — even after restarting the shell

🔧 Shell Fundamentals

• 🔀 Pipelines (cmd1 | cmd2 | cmd3)
• 📂 Redirects (>, >>, <)
• 🏠 Tilde & variable expansion (~, $HOME, ${VAR})
• 📟 Full PTY support for interactive programs (vim, top, etc.)

📦 Install

Prerequisites

Install via Cargo

cargo install jarvish

Build from Source

git clone https://github.com/tominaga-h/jarvis-shell.git
cd jarvis-shell
cargo install --path .

Setup

Set your OpenAI API key as an environment variable:

export OPENAI_API_KEY="sk-..."

Configuration

Jarvish uses a TOML configuration file located at ~/.config/jarvish/config.toml. A default config file is automatically generated on first launch.

[ai]
model = "gpt-4o"        # AI model to use
max_rounds = 10          # Max agent loop rounds

[alias]
g = "git"                # Command aliases
ll = "ls -la"

[export]
PATH = "/usr/local/bin:$PATH"   # Environment variables set on startup

[prompt]
nerd_font = true         # Set to false if NerdFont is not installed

Tip: You can reload the config at runtime with the source builtin command:

source ~/.config/jarvish/config.toml

Run

jarvish

🏗️ Architecture

Jarvish is composed of four core components:

graph TB
    User(["User"]) --> A["Line Editor (reedline)"]
    A --> B["Execution Engine"]
    B --> B1["Builtin Commands (cd, cwd, exit)"]
    B --> B2["External Commands (PTY + I/O Capture)"]
    B --> D["AI Brain (OpenAI API)"]
    B2 --> C["Black Box"]
    D --> C
    C --> C1[("history.db (SQLite)")]
    C --> C2[("blobs/ (SHA-256 + zstd)")]

🛠️ Tech Stack

👩‍💻 Development

Git Hooks

make install-hooks   # Install pre-push hook
make uninstall-hooks # Remove pre-push hook

Run Checks

make check  # Run format, clippy, check, and test

CI Pipeline (GitHub Actions)

The CI runs on every push and PR to main: