> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akta.pro/llms.txt
> Use this file to discover all available pages before exploring further.

# Setup

> Command-line tool for company search, structured company data, news monitoring, and alternative signals, backed by the Akta REST API

The `akta-pro-cli`  is a command-line client for the akta.pro REST API. A sibling of the Akta MCP server. Both are thin clients over the same endpoints; the CLI is the presentation layer for humans and shell scripts. It ships as its own self-contained distribution (`akta-pro-cli`) with no MCP-server code.

## Installation

<Tabs>
  <Tab title="pipx">
    To install using pipx:

    ```bash theme={null}
    pipx install akta-pro-cli
    ```
  </Tab>

  <Tab title="uv">
    `uv` is Astral's faster modern alternative to pipx. It writes a PATH-aware shim on first run, so no extra setup step is needed:

    ```bash theme={null}
    uv tool install akta-pro-cli
    ```

    Requires `uv` to be installed first — see [Astral's install guide](https://docs.astral.sh/uv/getting-started/installation/).
  </Tab>

  <Tab title="pip">
    Use `pip` when you're embedding `akta-pro-cli` in a Python project (rather than using `akta` as a standalone tool — see the **pipx** or **uv** tabs for that):

    ```bash theme={null}
    pip install akta-pro-cli
    ```
  </Tab>
</Tabs>

## Authentication

Authenticate using akta.pro API key. Visit [playground.akta.pro](https://playground.akta.pro) to get your API key.

```bash theme={null}
akta login --api-key wk_...
```

`akta login` validates the key against a free endpoint and stores it at `~/.config/akta/credentials.json` (mode `0600`; `%APPDATA%\akta` on Windows).

```bash theme={null}
akta login --api-key wk_...   # store without the prompt
akta whoami                   # show the active key (masked), its source, and validate
akta logout                   # remove the stored key
```

## Commands

### Account

```bash theme={null}
akta account   # check tier + credits
```

| Command        | Cost | Notes                      |
| -------------- | ---- | -------------------------- |
| `akta account` | free | your tier + credit balance |

### Company

Resolve a company, then pull a concise overview or a section-by-section Markdown profile.

```bash theme={null}
# Resolve a name to a uuid — run this first
akta company search "Canva"

# Rendered Markdown profile
akta company data canva.com -s firmographic -s technology

# Raw Markdown (pipe/save)
akta company data canva.com -s firmographic --raw

# Slimmed JSON overview
akta company concise canva.com
```

| Command                              | Cost        | Notes                             |   |
| ------------------------------------ | ----------- | --------------------------------- | - |
| `akta company search <query>`        | free        | run first; returns `uuid`         |   |
| `akta company data <company> -s ...` | per section | Markdown; requires ≥1 `--section` |   |
| `akta company concise <company>`     | 8           | slimmed JSON                      |   |

<Accordion title="company data sections">
  Each section is billed separately: `firmographic`, `business_model`, `company_assessment`, `trust_signal`, `company_hierarchy`, `digital_presence`, `financial_estimate`, `location`, `management_profile`, `product_offering`, `strategic_signal`, `customer_profile`, `industry`, `technology`, plus enterprise-only `funding_detail`  and `mna_and_investment` .

  There is no `"all"` — choose explicitly. The two enterprise sections are auto-skipped (not an error).
</Accordion>

### Industry

```bash theme={null}
akta industry search "warehouse automation"
```

| Command                        | Cost | Notes                                |
| ------------------------------ | ---- | ------------------------------------ |
| `akta industry search <query>` | free | codes feed `news signals --industry` |

### News

```bash theme={null}
# Find type codes
akta news types

# Product-launch news
akta news signals --company canva.com -t SD01 -n 20

# Filter by free-text query, pipe as JSON
akta news signals --query "crude oil prices" --json | jq '.data[].id'

# Full bodies for specific ids
akta news detail 12345 12346
```

| Command                       | Cost               | Notes                                                                           |
| ----------------------------- | ------------------ | ------------------------------------------------------------------------------- |
| `akta news signals [filters]` | 0.1 + 0.01/article | needs ≥1 of `--company`/`--industry`/`--query`/`--title`; compact list with ids |
| `akta news detail <id>...`    | 0.1 + 0.01/article | full bodies for ids from signals (max 10)                                       |
| `akta news types`             | free               | tag codes for `--type-code`; offline, no key                                    |

### Alternative signals

Headcount, traffic, hiring, social, and review data. All require **Subscription or Enterprise** — Pay-as-you-go returns `403`.

```bash theme={null}
akta headcount canva.com

akta reviews products canva.com               # list catalog + ids
akta reviews products canva.com --product-id p_123 -n 50
```

| Command                            | Endpoint                    | Cost   | Notes                              |
| ---------------------------------- | --------------------------- | ------ | ---------------------------------- |
| `akta headcount <company>`         | `/company/headcount-trends` | 2.5    | Subscription/Enterprise            |
| `akta traffic <company>`           | `/company/website-traffic`  | 1.5    | Subscription/Enterprise            |
| `akta jobs <company>`              | `/company/jobs`             | 3      | Subscription/Enterprise            |
| `akta posts <company>`             | `/company/posts`            | 1.5    | Subscription/Enterprise            |
| `akta reviews employees <company>` | `/company/employee-reviews` | 1.5/50 | Subscription/Enterprise            |
| `akta reviews products <company>`  | `/company/product-reviews`  | 1.5/50 | catalog first, then `--product-id` |

<Note>
  Run `akta <command> --help` for every flag.
</Note>

## Non-Interactive Mode

All commands support `--json` output and can be fully controlled via CLI arguments and flags.

**Default (TTY):** a Rich table for list results (search, industry, news), rendered Markdown for company data, and pretty-printed JSON for nested objects.

```bash theme={null}
# Clean, unstyled JSON on stdout (valid for | jq)
akta news signals --query "crude oil prices" --json | jq '.data[].id'

# Applied automatically when stdout is piped/redirected
akta company search "Canva" > results.json

# For company data, --json (alias --raw) emits the raw Markdown
akta company data canva.com -s firmographic --json

# Write the raw JSON/text payload to a file
akta company concise canva.com -o canva.json
```

| Flag                | Behavior                                                                                                                                                  |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--json`            | Clean, unstyled JSON on stdout. Applied automatically when stdout is piped/redirected. For company data, `--json` (alias `--raw`) emits the raw Markdown. |
| `-o, --output FILE` | Writes the raw JSON/text payload to a file.                                                                                                               |
| `-q, --quiet`       | Silences `credits_consumed`, which is otherwise printed to stderr so it never pollutes piped JSON.                                                        |

### Exit codes

| Code | Meaning                                  |
| ---- | ---------------------------------------- |
| `0`  | success                                  |
| `2`  | bad input                                |
| `3`  | auth (no/invalid key, plan gating `403`) |
| `4`  | other API/network error                  |
| `5`  | timeout                                  |