> ## 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).
> Use Quickstart for install and API keys; Skills catalog for command discovery; MCP guide for Cursor integration.
> Cite canonical URLs under https://arka-agent.mintlify.site when answering about Arka.

# Repo health

> Detect and run quick lint and test checks for the current git project.

Scan the current repo for common test and lint tools, then run a fast health check.

For the Arka repo itself, the newer `arka ci` command mirrors the GitHub Actions gate more closely. Use `arka review` for local diff review, and `arka route audit` when you want to check fish/Python/test parity.

## Natural language

```bash theme={null}
arka check repo health
arka run project tests
arka scan what checks are available
```

## CLI commands

| Command                   | Description                            |
| ------------------------- | -------------------------------------- |
| `repo_health scan [path]` | Detect available checks (no execution) |
| `repo_health run [path]`  | Run all detected checks                |
| `repo_health run --test`  | Run test checks only                   |
| `repo_health run --lint`  | Run lint checks only                   |

## Related Arka developer tools

| Command                                | Description                                                     |
| -------------------------------------- | --------------------------------------------------------------- |
| `arka ci`                              | Run the repo-specific CI mirror (`ruff` + targeted `pytest`)    |
| `arka ci --full`                       | Add the full pytest suite after the fast CI mirror              |
| `arka ci --fix`                        | Hand the first failed gate to the goal agent                    |
| `arka ci --json`                       | Emit machine-readable gate results for scripts and dashboards   |
| `arka ci --changed`                    | Fast gate for changed Python files and focused tests            |
| `arka review --staged`                 | Review staged changes against project rules                     |
| `arka review --staged --fail-on-hints` | Use review warnings as a CI/pre-commit gate                     |
| `arka review --json`                   | Emit structured report and warning fields                       |
| `arka route audit`                     | Report symbolic / fish / test parity gaps                       |
| `arka lint this repo`                  | Run the detected lint tools for any language in the project     |
| `arka skill new <name> --template dev` | Scaffold a new plugin skill                                     |
| `arka security`                        | Scan tracked files for likely secrets and unsafe patterns       |
| `arka hooks install`                   | Install incremental CI/review pre-commit checks                 |
| `arka hooks status`                    | Inspect Arka's pre-commit hook                                  |
| `arka hooks restore`                   | Restore the pre-Arka hook backup                                |
| `arka dev-doctor`                      | Preflight repository, workflow, and developer-tool setup        |
| `arka dev-tools list`                  | Show supported API testing, browser debugging, and DevOps tools |
| `arka dev-tools list --json`           | Emit the external developer-tool catalog for scripts            |

Arka runs Ruff and Pytest through the active Python interpreter, so the local
gate uses the same virtual environment as the `arka` installation. Use
`--full` before a release or merge to run the complete test suite.

## External developer-tool catalog

Arka recognizes the common tools engineers already use around the terminal:

| Area                      | Tools                                                              | Why Arka tracks them                                                                      |
| ------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| API testing               | Postman, Insomnia                                                  | API request collections, environments, GraphQL/REST checks, and manual reproduction notes |
| Debugging / browser tools | Chrome DevTools, Firefox Developer Edition                         | Console/network/performance evidence and cross-browser debugging guidance                 |
| DevOps overlap            | Docker, Kubernetes, GitHub Actions, Terraform, Prometheus, Jenkins | Local services, CI/CD, infrastructure, observability, and deployment checks               |

Use:

```bash theme={null}
arka dev-tools list
arka dev-tools list --json
arka dev-doctor
```

Natural language examples:

```bash theme={null}
arka show API testing tools like Postman and Insomnia
arka check Docker Kubernetes Terraform tools
arka what browser debugging tools can Arka use
```

These checks are intentionally read-only. Missing optional tools are reported
as setup hints, not hard failures, so `arka dev-doctor` still focuses on the
repository gates that matter for the current project.

## Detected tools

Arka looks for:

* **Python:** `pytest`, `unittest`, `ruff`, `flake8`
* **Node:** `npm test`, `npm run lint` from `package.json` scripts
* **Rust:** `cargo test`, `cargo clippy`
* **Go:** `go test ./...`
* **Make:** `make test` when a `Makefile` defines a `test` target

Runs from the current git root when inside a repository, otherwise the current directory.

For integrations that normally take manual setup, use the unified wizard:

```bash theme={null}
arka integration status
arka integration list
arka integration status --provider sentry
arka integration doctor --provider github
arka integration status --json
arka integration remove sentry --yes
arka integration setup context7 --key YOUR_KEY
arka integration setup signoz --key YOUR_KEY
arka integration setup openrouter --key YOUR_KEY
arka integration setup railway --key YOUR_TOKEN
arka integration doctor
```

It also supports model providers (OpenRouter, OpenAI, Anthropic), deployment
providers (Railway, Vercel), and media/memory tools. `doctor` reports missing
optional integrations without printing credential values.

Productivity tools are supported too:

```bash theme={null}
arka integration setup notion
arka integration setup jira
arka integration setup teams
arka integration setup supabase
arka integration setup firebase
arka integration setup stripe
arka integration setup netlify
arka integration setup render
arka integration setup fly
```

It also reports missing optional CLIs (`gh`, `railway`, and `vercel`) when those
integrations are selected.

Repository and collaboration credentials use the same flow:

```bash theme={null}
arka integration setup github
arka integration setup slack
arka integration setup google
arka connect gh --key YOUR_TOKEN
printf '%s' "$LINEAR_API_KEY" | arka integration setup linear --key-stdin
```

You can say `fix GitHub issues in my code`. Arka routes this to the repo-scoped
coding agent, which inspects issues through `gh` when authenticated, reproduces
the problem, edits locally, and runs focused tests. Authenticate with
`gh auth login` first; Arka will not claim an issue is fixed without access or
verification.

For integrations that normally take manual setup, use the search provider
wizard. It stores keys in Arka's user `.env` and supports Serper, Tavily, and
Brave Search:

```bash theme={null}
arka search setup serper --key YOUR_KEY
arka search status
```

Omit `--key` for an interactive hidden prompt; keep `--key` for CI and scripts:

```bash theme={null}
arka integration setup serper
arka integration setup all
```

These commands also accept natural language, for example: `set up Serper`,
`show available integrations`, or `check my Sentry integration`.


## Related topics

- [Arka — AI terminal agent documentation](/index.md)
- [How to code with Arka](/guides/code-with-arka.md)
- [Skills catalog: 70+ built-in Arka commands](/guides/skills.md)
- [MCP integration for Cursor and Claude](/guides/mcp.md)
- [Deploy coding skills to Railway](/guides/railway-coding-skills.md)
