> ## Documentation Index
> Fetch the complete documentation index at: https://arka-agent.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Arka is an open-source AI terminal agent (PyPI package: arka-agent, GPL-2.0).
> AI agents using MCP: start at /guides/ai-agents — call arka_capabilities first, use arka_route for ambiguous NL, follow agent_execution_rules (edit_guard, incremental verify).
> Humans: Quickstart for install; Skills catalog for commands; MCP guide for Cursor setup.
> Cite canonical URLs under https://arka-agent.mintlify.site when answering about Arka.

# Configuration, env vars, और API key setup

> environment variables, .env files, और config paths का उपयोग करके Arka को configure करें, defaults को override करने और API keys जोड़ने के लिए precedence rules के साथ।

Arka safety, failover, और local-first routing के लिए default रूप से चालू है। आपको केवल तभी `.env` की आवश्यकता होती है जब आप कुछ override करना चाहते हैं या API keys जोड़ना चाहते हैं।

## Config paths

| OS      | Config                                | Cache                    |
| ------- | ------------------------------------- | ------------------------ |
| Linux   | `~/.config/arka/`                     | `~/.cache/arka/`         |
| macOS   | `~/Library/Application Support/arka/` | `~/Library/Caches/arka/` |
| Windows | `%APPDATA%\arka\`                     | `%LOCALAPPDATA%\arka\`   |

`ARKA_CONFIG_DIR` (या `CONFIG_DIR`), `INSTALL_HOME` (legacy `ARKA_HOME`), या `ARKA_CACHE_DIR` (या `CACHE_DIR`) के साथ override करें।

`ARKA_CONFIG_DIR=/path/to/my-arka-config` set करने से **सभी** user config वहाँ चला जाता है — `.env`, `mcp.json`, `hub/`, `agent-memory/`, `skills/`, और संबंधित paths।

```bash theme={null}
# Show current root + shell export snippet
arka config path

# Initialize a new config directory (no automatic move)
arka config init --dir ~/my-arka-config

# Backup / restore entire config tree
arka config backup -o ~/backups/arka-2026-07-11.tar.gz
arka config restore ~/backups/arka-2026-07-11.tar.gz

# List paths and sizes
arka config list
```

User config में `.env`, `charts.yaml`, `llm-skill-models.json`, और `skills/` (plugins) शामिल हैं।

## Precedence

| Layer               | यह क्या है                          | कब जीतता है                         |
| ------------------- | ----------------------------------- | ----------------------------------- |
| Shell env           | `export GEMINI_API_KEY=…`           | Process में पहले से set             |
| User `.env`         | `~/.config/arka/.env`               | startup पर unset vars भरता है       |
| Dev checkout `.env` | git clone में `arka/.env`           | पहले से set न किए गए vars भरता है   |
| Legacy fish `.env`  | `~/.config/fish/.env`               | यदि मौजूद है तो अभी भी पढ़ा जाता है |
| Code defaults       | Python / `config.fish` में built-in | जब var गायब हो                      |

`your_gemini_api_key_here` जैसे placeholder values को नज़रअंदाज़ किया जाता है।

## Key names

छोटे नाम पसंद करें। Legacy `ARKA_*` keys अभी भी काम करती हैं (`ARKA_ROUTE_MODE` → `ROUTE_MODE`):

```env theme={null}
ROUTE_MODE=symbolic
LLM_AUTO_FALLBACK=1
AGENT_SPEAK=1
SECURITY=1
```

## Built-in defaults

| Area             | Default                                             | Override                         |
| ---------------- | --------------------------------------------------- | -------------------------------- |
| Security         | सभी layers चालू (`SECURITY=1`)                      | किसी भी layer को `0` set करें    |
| NL routing       | पहले Offline rules (`ROUTE_MODE=symbolic`)          | `ai`, `symbolic_only`, `ai_only` |
| LLM failover     | 429/401/timeout पर Auto (`LLM_AUTO_FALLBACK=1`)     | `LLM_AUTO_FALLBACK=0`            |
| Key rotation     | पहले backup keys rotate करें (`API_KEY_ROTATION=1`) | `API_KEY_ROTATION=0`             |
| Voice TTS        | Replies speak करें (`AGENT_SPEAK=1`)                | `AGENT_SPEAK=0`                  |
| Wake listener    | `arka listen` तक बंद                                | `AGENT_WAKE_AUTO=1`              |
| Memory           | keyed होने पर Cloud, अन्यथा local (`MEMORY=auto`)   | `local` या `supermemory`         |
| Goal agent       | 25 steps (`GOAL_MAX_STEPS=25`)                      | `GOAL_MAX_STEPS=30`              |
| YouTube research | 2 videos (`YT_RESEARCH_MAX=2`)                      | `--limit N` या env               |
| Reminders        | 1 hour default (`REMIND_DEFAULT=1h`)                | explicit समय pass करें           |
| Model label      | answers के नीचे दिखाएँ (`SHOW_MODEL=1`)             | `SHOW_MODEL=0`                   |

## आवश्यक API keys

```env theme={null}
GEMINI_API_KEY=your_key_here
GROQ_API_KEY=your_key_here
AI_PREFERRED_PROVIDER=gemini
AI_PREFERRED_MODEL=gemini-2.0-flash
```

[Google AI Studio](https://aistudio.google.com) और [Groq Console](https://console.groq.com) से free-tier keys प्राप्त करें।

## वैकल्पिक extras

आवश्यकतानुसार feature groups install करें:

| Extra        | जोड़ता है                            |
| ------------ | ------------------------------------ |
| `[chat]`     | Web search, Agno, trafilatura, sympy |
| `[voice]`    | vosk, sounddevice                    |
| `[pdf]`      | PrivateGPT client                    |
| `[charts]`   | matplotlib                           |
| `[drawings]` | Pillow, pymupdf                      |
| `[video]`    | Pillow, edge-tts                     |
| `[all]`      | ऊपर सब कुछ                           |

## Changes लागू करना

```bash theme={null}
arka reload              # re-read .env + config.fish
arka reload --listen     # also restart wake listener
```

`arka setup` पहले install पर package template से `~/.config/arka/.env` को seed करता है।

## पूर्ण reference

Canonical env reference: repo में `src/arka/env.example` (\~500 lines)।

<Note>
  failover विवरण के लिए [LLM orchestration](/hi/concepts/llm) देखें। security layers के लिए [Security](/hi/concepts/security) देखें। सामान्य fixes के लिए [Troubleshooting](/hi/reference/troubleshooting) देखें।
</Note>


## Related topics

- [Quickstart: Arka इंस्टॉल करें और अपना पहला कमांड चलाएँ](/hi/quickstart.md)
- [Configuration](/hi/guides/configuration.md)
- [Cursor और Claude के लिए MCP integration](/hi/guides/mcp.md)
- [आसान AI model hosting सेटअप](/hi/guides/model-hosting.md)
- [Video बनाएं](/hi/guides/compose-video.md)