Mira API Docs

Mira Code Reference

Complete reference documentation for all Mira Code CLI flags, environment variables, configuration files, and the permission system.

CLI Flags

Mira Code supports the following command-line flags:

FlagDescriptionExample
--version, -vDisplay current versionmira --version
--help, -hShow help informationmira --help
--modelSelect AI modelmira --model mira-pro
--print, -pNon-interactive output (for scripting)mira -p "explain this"
--continue, -cContinue most recent conversationmira --continue
--resume, -rResume a session by IDmira -r SESSION_ID
--yoloSkip all permission checksmira --yolo
--effortEffort level (low, medium, high, max)mira --effort high
--system-promptSystem prompt overridemira --system-prompt "Be terse"
--verboseVerbose outputmira --verbose
CLI flags have the highest priority and override all other configuration sources.

Environment Variables

You can configure Mira Code behavior using environment variables:

VariableDescriptionDefault
MIRA_API_KEYAPI key for authenticationnone
MIRA_BASE_URLBase API URLhttps://api.vmira.ai
MIRA_MODELDefault modelmira
MIRA_AUTH_URLAuthentication endpoint URLhttps://api.vmira.ai
MIRA_CONFIG_DIRConfiguration directory~/.mira
Setting environment variables (bash)
# Add to your ~/.bashrc or ~/.zshrc
export MIRA_API_KEY="sk-mira-your-key-here"
export MIRA_MODEL="mira-pro"
export MIRA_BASE_URL="https://api.vmira.ai"

Configuration Files

Global Configuration

Global configuration is stored at ~/.mira.json and applies to all projects:

~/.mira.json
{
  "apiKey": "sk-mira-your-key-here",
  "theme": "dark",
  "autoUpdates": true,
  "verbose": false
}
The ~/.mira.json file is created automatically on first authentication. Your API key is stored in the apiKey field.

Project Configuration

Project settings are stored at .mira/settings.json in the project root and override global settings:

.mira/settings.json
{
  "permissions": {
    "allow": ["Read", "Edit", "Write", "Bash(npm test:*)"],
    "deny": ["Bash(rm *)"]
  },
  "env": {
    "MIRA_MODEL": "mira-pro"
  }
}

Key Options

Global config (~/.mira.json)

FieldTypeDescription
apiKeystringMira API key (sk-mira-...)
themestringColor theme: "dark" or "light"
autoUpdatesbooleanAuto-update the CLI
verbosebooleanVerbose logging output

Project settings (.mira/settings.json)

FieldTypeDescription
permissions.allowstring[]Allowed tools (Read, Edit, Write, Bash(...))
permissions.denystring[]Denied tools
envobjectEnvironment variables for the session (MIRA_MODEL, etc.)

Permission System

Mira Code uses a permission system to control access to files and commands. Each action can be in one of three modes:

  • ask — Ask for confirmation before each action (default for write and command execution)
  • auto — Perform action without confirmation (default for file reads)
  • deny — Completely block the action
Be careful with auto mode for fileWrite and commandExecution. It is recommended to use ask for these actions, especially in production environments.

Supported File Types

Mira Code works with all text files and provides syntax highlighting for 50+ programming languages, including:

TypeScript, JavaScript, Python, Rust, Go, Java, C, C++, C#, Ruby, PHP, Swift, Kotlin, Dart, Lua, Scala, Haskell, Elixir, Clojure, HTML, CSS, SCSS, SQL, GraphQL, YAML, JSON, TOML, Markdown, Dockerfile, Terraform, and many more.