CLI

akkru is the AkkruData command line, for your terminal, your scripts and AI agents that run shell commands. It needs Python 3.11 or later.

#Install

Shell
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

CommandWhat it does
akkru auth loginOpens the browser: sign in to AkkruData and click Authorize. With --no-browser it prints the address instead.
akkru auth login --with-keySigns in with an API key: give the key after the option, type it when asked, or pipe it in.
akkru auth statusHow this machine is signed in, and the credits left.
akkru auth logoutSigns 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. A browser sign-in is one of your account's connections.

#Run a command

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

Each command is one tool. The tool's page lists its actions, parameters and credits:

CommandTool
akkru companiesCompanies
akkru filingsFilings
akkru statementsStatements and notes
akkru factsFinancial facts
akkru metricsComputed metrics
akkru insider-transactionsInsider transactions (Form 4)
akkru initial-holdingsInitial holdings (Form 3)
akkru institutional-holdingsInstitutional holdings (13F)
akkru eventsCorporate events (Form 8-K)
akkru accountAccount
  • 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.
Shell
akkru facts get --ticker AAPL --fiscal-year 2025 --json '{"line_items": ["revenue", "net income"]}'

#Help

CommandShows
akkru --helpThe tools, the sign-in and setup commands, and the limits.
akkru <tool> --helpThe tool's actions and their credits.
akkru <tool> <action> --helpThe action's flags, its limit and an example.
akkru schema <tool>.<action>Every parameter of the action, as JSON Schema.
akkru help actionsEvery action of every tool.
akkru help agentHow an AI agent should use akkru.
akkru --versionThe installed version.

#Output

A command prints one JSON object on standard output: {"ok": true, "data": ...} with the reply in data, or {"ok": false, "error": {...}}. It is indented in a terminal and compact otherwise. The hint of a successful reply, and notices, go to standard error.

The error has the same fields as an MCP error, and source can also be cli: the error happened on this machine. TOOL_FLAG_INVALID means a flag's value is not of its parameter's type, or a list or an object was given as a flag.

Exit codeMeaning
0Success.
1The API returned an error, or could not be reached.
2The command was wrong, or failed on this machine.
3A multi-page run stopped early.
4Sign-in needed: not signed in, expired or disconnected.

#Pages

--pages N fetches up to N pages (at most 2,000) of a paged action in one run, from --page (default 1), at the largest page size the action takes unless --page-size is given. Without --yes only the first page is fetched, and the reply says how to go on. Each page is charged. The pages come back as a list in data, with next_page. A run that stops early prints the pages it has, with a warning and next_page, and exits with code 3.

#Credits and limits

Each action costs the credits its tool page shows, from your account's balance, also when run from a script or a scheduled job. Calls refused with source tool or cli are not charged. akkru account balance shows the credits left.

Each account can make up to 120 tool calls a minute. The tool definitions can be downloaded up to 30 times a minute. Each tool action also has a limit: MCP and CLI rate limits.

#Updating

When a newer version is out, akkru prints a notice. Upgrade with pipx upgrade akkru, uv tool upgrade akkru or pip install -U akkru, whichever installed it, then run akkru setup to update the skill.

#Files and environment variables

NamePurpose
~/.akkru/The sign-in, the tool definitions and the other files akkru saves (%USERPROFILE%\.akkru\ on Windows).
AKKRU_API_KEYAn API key, used instead of any saved sign-in.
AKKRU_CONFIG_DIRAnother folder for these files, instead of ~/.akkru/.
CLAUDE_CONFIG_DIR, CODEX_HOMEWhere akkru setup looks for Claude Code and Codex.

#Uninstall

Shell
akkru uninstall --yes
pipx uninstall akkru

Without --yes, akkru uninstall only lists what it would remove. With --yes it signs out and removes the skill and the files akkru saved. Then remove the package with pipx uninstall akkru, uv tool uninstall akkru or pip uninstall akkru, whichever installed it.