Quickstart

Step 1: Install Junie CLI

In the terminal or command prompt of your choice, run:

Step 2: Start Junie in your project

Navigate to the root directory of the project where you want to use Junie CLI and run junie:

Step 3: Authenticate

On the Junie welcome screen, select one of the available authentication options:

• Log in with your JetBrains Account

  Use Junie CLI as part of your subscription plan with JetBrains. When selecting this option, you'll be redirected to the JetBrains Junie login page in your browser.

• Use JUNIE_API_KEY

  Run Junie CLI with usage-based billing. When selecting this option, you'll be prompted to provide an access token. To generate your JUNIE_API_KEY access token, go to junie.jetbrains.com/cli.

• Bring Your Own Key (BYOK)

  Use your own API keys or OAuth tokens from Anthropic, OpenAI, Google, or other third-party LLM providers. Junie CLI uses these API keys to send requests to LLMs directly without requiring a JetBrains AI subscription.

  BYOK can be used on its own or together with JetBrains Account authorization or Junie API key. If a model is available through both the BYOK API key and JetBrains AI subscription, the requests are billed to your BYOK provider directly.

Step 4: Type your prompt

Type the prompt in the interactive CLI, for example:

Use @ to attach a file or folder from the current project to the request context. To see the list of available slash commands and use them, type /.

Reference files and directories

Use @ to quickly reference files or directories in your prompt.

You can also drag and drop files and images into the terminal window to reference them.

Slash commands and shortcuts

Slash commands allow you to access various Junie CLI features directly from the prompt. Type / in the prompt to see and use the available slash commands.

Some built-in slash commands accept user prompts as arguments. For example, /new fix tests starts another live session with fix tests in the prompt, and /plan refactor commands enables plan mode and submits refactor commands immediately.

In addition to the built-in commands, you can add custom slash commands for frequently used prompts and repetitive tasks.

To see all available shortcuts, type ?.

Run shell commands

You can run shell commands without leaving Junie CLI by prefixing it with !, for example:

Command approval

For running potentially sensitive actions, such as executing most of the terminal commands, editing files outside the project, or invoking MCP tools, Junie CLI will ask for approval from the user.

Action Allowlist

When Junie CLI stops for user approval, you can select the → Always allow option to add the indicated command to the Action Allowlist. Once on the Action Allowlist, the command will always be executed without user approval in the future Junie CLI runs.

The full list of allowed commands and command patterns is stored in the ~/.junie/allowlist.json file. You can also edit this file manually to add or remove allowed or restricted commands and patterns. For details, see Action Allowlist configuration.

Brave mode

Brave mode controls how much Junie CLI relies on user approval before running potentially sensitive actions. It has three levels that you can cycle through with the /brave slash command or the Ctrl+B shortcut:

• Off – Junie CLI asks for approval for every potentially sensitive action that is not on the Action Allowlist. This is the most conservative behavior.

• Auto – Junie CLI classifies terminal commands with a safety check and automatically approves the ones it considers safe, while still asking for approval for risky or unrecognized commands and for other sensitive actions.

• On – Junie CLI executes all potentially sensitive actions without user approval.

Plan mode

In plan mode, Junie CLI analyzes the codebase with read-only operations and produces a design document for the task before any code is written. Toggle plan mode with the Shift+Tab shortcut or the /plan slash command.

You can also start Junie CLI directly in plan mode using the --plan flag:

For details, see Plan mode.

Debug mode

In debug mode, Junie CLI acts as an AI debugging assistant that manages breakpoints, inspects runtime state, and evaluates expressions against a live debugger session in a connected JetBrains IDE. Toggle debug mode with the Shift+Tab+Tab shortcut or the /debug slash command. For details, see Debug Mode.

Local code review

Use the /review slash command to run a code review of your local changes before you commit them. Junie CLI uses the same review backend as automated code reviews on GitHub, so the feedback you get locally is consistent with what would be reported on a pull request.

When you run /review, Junie CLI detects the git state of the project and offers a wizard with only the review targets that make sense in the current state:

• From Main: review your current branch against main. Shown only when a main branch exists and you are not currently on it (there is nothing to compare if you are already on main).

• Last Commit: review the diff of the most recent commit. Always available as long as the project has at least one commit.

• Unstaged Changes: review changes that are not yet staged. Shown only when there are actual unstaged changes in the working tree.

Pick an option, and Junie CLI will start a review task that comments on the selected diff.

After the review is complete, Junie CLI presents the findings and lets you accept or dismiss individual comments.

Manage your account

Use the /account command to manage your credentials and API keys:

• Select Junie Account to authenticate with Junie CLI via JetBrains Account or a Junie API key.

  To generate a JUNIE_API_KEY access token, go to junie.jetbrains.com/cli.

• Select Bring Your Own Key (BYOK) to add API keys for LLM providers like OpenAI, Anthropic, Google, or xAI.

Manage your session

Model and effort

Use /model to select the LLM and, for supported models, the reasoning effort level used for the current session. Default is the recommended pre-selected option that uses a dynamically set model with the best price-quality ratio.

The selection of available models depends on your authentication method with Junie CLI. With BYOK, only the provider-specific models are available.

Effort level

For models that support adjustable reasoning effort (for example, recent Claude, GPT-5, and Gemini models), you can pick how hard the model thinks before answering. The set of supported effort levels (such as Low, Medium, High, XHigh, Max) depends on the selected model.

You can change the effort level in two ways:

• Use the /model command and pick an effort level alongside the model.

• Use the dedicated /effort command to change only the effort level for the current model.

You can also set the default effort level for new sessions with the --effort <level> CLI flag or the JUNIE_EFFORT environment variable. For details, see Model selection.

Token usage and costs

The /usage command shows the cost breakdown for the current session, including token usage, used models, and remaining balance.

Extend Junie CLI

• Model Context Protocol (MCP)

• Agent skills

• Subagents

• Custom slash commands

• Guidelines and memory

Non-interactive (headless) mode

You can run Junie CLI in headless mode, that is, programmatically without interactive UI, in CI/CD environments and build pipelines.

To add Junie to your CI/CD script:

The junie command takes options and environment variables.

For more information and examples, see Headless mode.

Junie in CI/CD pipelines

• Junie GitHub Action

• Junie GitLab CI/CD