Getting started

What is Jarvis Code CLI

Jarvis Code CLI is an AI agent that runs in the terminal, helping you carry out software development tasks and day-to-day terminal operations — reading and modifying code, running shell commands, searching files, fetching web pages, and autonomously planning and adjusting its next steps based on feedback as it works.

It fits scenarios such as:

• Writing and modifying code: implementing new features, fixing bugs, completing refactors
• Understanding a project: exploring an unfamiliar codebase and answering questions about architecture and implementation
• Automating tasks: batch-processing files, running builds and tests, chaining multiple scripts together

The CLI is distributed as a native release ZIP for Linux x64 (glibc) and Windows x64. macOS, Linux ARM, and musl-based Linux distributions are not supported by the release installers.

Installation

Install with the release installer; no pre-installed Node.js is required. Releases are published at GitHub Releases.

Before you install

Jarvis Code CLI is a fully interactive TUI application. For the best visual experience, run it in a terminal with true-color and ligature support, such as Kitty or Ghostty.

Install script (recommended)

Linux x64

curl -fsSL https://releases-jarviscode.rollin-apps.store/install.sh | bash

Windows x64 (PowerShell)

irm https://releases-jarviscode.rollin-apps.store/install.ps1 | iex

The installer downloads the versioned jarvis-code-<version>-linux-x64.zip or jarvis-code-<version>-win32-x64.zip archive, verifies it against the matching .sha256 file, and places jarvis on your PATH. To install a specific release, set JARVIS_VERSION to a production tag in the jarvis-v<semver> format, such as jarvis-v0.38.1.

Windows builds are unsigned. Microsoft Defender SmartScreen may show a warning; confirm that the download came from this repository's GitHub Release and its .sha256 checksum matches before using Windows' More info → Run anyway option.

First launch

Move into your project directory and run jarvis to start the interactive UI:

cd your-project
jarvis

To run a single instruction without entering the interactive UI, use -p:

jarvis -p "Take a look at this project's directory structure"

To resume the previous session, add -c:

jarvis -c

On first launch you need to configure an API source. In the interactive UI, enter /login to begin the login flow:

/login

/login opens a platform selector:

• Jarvis Code (OAuth) — choose kimi.com/code or kimi.ai/code, then complete the device-code flow in a browser.
• Kimi Open Platform (API key) — enter an API key issued at platform.kimi.com or platform.kimi.ai; this is a separate pay-per-token platform, not a Jarvis Code login.

To sign out, enter /logout to clear the current credentials.

Using other AI providers

If you want to connect Anthropic, OpenAI, Google, or other providers, edit ~/.jarvis-code/config.toml directly to configure the API key. See Providers and models for details. For the full reference of all config options, see Configuration files, Environment variables, and Configuration overrides.

Your first conversation

Once logged in, describe a task in natural language. A good starting point is to let Jarvis Code CLI familiarize itself with the project:

Take a look at this project's directory structure and briefly describe what each directory is for.

Jarvis Code CLI automatically calls file-reading, search, and other tools to browse the relevant content before responding. Read-only operations are executed automatically by default without requiring confirmation. For operations that modify files or run shell commands, it asks for your confirmation before proceeding.

You can also describe a more concrete task directly:

Add a function in src/utils that converts any string to kebab-case, and add a unit test for it.

Jarvis Code CLI plans the steps, modifies the code, runs the tests, and tells you what it did at each step.

Not sure what to do? Type /help

Type /help at any time to open the built-in command and keyboard shortcut panel. Use ↑/↓ to browse and Esc to close. To exit, type /exit, press Ctrl-C twice, or press Ctrl-D with the input box empty.

Common commands and keyboard shortcuts

For a first-time user, the following is all you need to know:

Session commands

Command	Description
/new	Start a new session, clearing the current context
/sessions	Browse session history and choose one to resume
/model	Switch the current model
/compact	Manually compress the context to free up tokens
/fork	Fork the current session into an independent copy with full history (you stay in the current session)
/logout	Sign out of a configured provider (alias: /disconnect)

Most-used keyboard shortcuts

Shortcut	Description
Esc	Interrupt streaming output / close a popup
Ctrl-C	Interrupt output; press twice while idle to exit
Shift-Tab	Toggle Plan mode
Ctrl-S	Inject a message mid-stream without waiting for the current response to finish
Ctrl-O	Collapse / expand tool output and compaction summaries

For the full list, type /help or visit Slash commands reference and Keyboard shortcuts.

Where data is stored

Jarvis Code CLI stores its local data under ~/.jarvis-code/ by default — config files, session records, logs, and the update cache. To move it elsewhere, point to a new path via the JARVIS_CODE_HOME environment variable. For the full directory layout, see Data locations and Environment variables.

Upgrade and uninstall

After installation, verify that the executable is ready:

jarvis --version

Upgrade: rerun the installer. It downloads the latest production release and replaces the installed jarvis binary.

Uninstall: delete ~/.jarvis-code/bin/jarvis on Linux or %USERPROFILE%\.jarvis-code\bin\jarvis.exe on Windows, then remove ~/.jarvis-code/bin or %USERPROFILE%\.jarvis-code\bin from your PATH. If you set JARVIS_INSTALL_DIR, use its bin directory instead. This leaves your configuration and session data in place.

Next steps

• Interaction and input — input box operations, approval flow, Plan mode, and YOLO mode explained
• Sessions and context — resuming sessions, compressing context, exporting sessions
• Common use cases — prompt examples for typical tasks