Metadata-Version: 2.5
Name: akkru
Version: 0.1.0
Summary: Command-line interface for AkkruData: financial statements, facts, metrics, insider and institutional holdings and corporate events from regulatory filings.
Project-URL: Homepage, https://www.akkrudata.ai
Project-URL: Repository, https://github.com/akkrudata/akkru-cli
License-Expression: MIT
License-File: LICENSE
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.11
Requires-Dist: httpx<1,>=0.27
Description-Content-Type: text/markdown

# AkkruData CLI

`akkru` is the [AkkruData](https://www.akkrudata.ai) command line, for your terminal, your scripts and AI agents that run shell commands. It needs Python 3.11 or later.

## Install

```bash
pipx install akkru
akkru setup
```

`uv tool install akkru` or `pip install akkru` also installs it. `akkru setup` downloads the tool definitions, installs the AkkruData skill for Claude Code and Codex when they are on the machine, and signs you in if you are not signed in yet.

## Sign in

| Command | What it does |
|---|---|
| `akkru auth login` | Opens the browser: sign in to AkkruData and click **Authorize**. With `--no-browser` it prints the address instead. |
| `akkru auth login --with-key` | Signs in with an [API key](https://www.akkrudata.ai/dashboard/api-keys): give the key after the option, type it when asked, or pipe it in. |
| `akkru auth status` | How this machine is signed in, and the credits left. |
| `akkru auth logout` | Signs out. |

When `AKKRU_API_KEY` is set, `akkru` uses that key instead of any saved sign-in. Use an API key for scripts, scheduled jobs, CI and servers.

## Run a command

```text
akkru <tool> <action> [--flag value ...] [--json JSON]
```

- A parameter that takes a single value is a flag, written with hyphens: `fiscal_year` is `--fiscal-year`.
- Lists and objects go in `--json`: a JSON object, `@FILE` to read one from a file, or `-` to read standard input.
- Every action takes `--detail full|light|minimal`, all charged the same.

```bash
akkru facts get --ticker AAPL --fiscal-year 2025 --json '{"line_items": ["revenue", "net income"]}'
```

`akkru --help` lists the tools, `akkru <tool> --help` a tool's actions and their credits, and `akkru <tool> <action> --help` the action's flags, its limit and an example.

## Documentation

[CLI documentation](https://www.akkrudata.ai/documents/cli): output, exit codes, pages, credits and limits, files and environment variables, and uninstalling.

## License

MIT
