# PentAGI

This recipe generates the `pentagi` CLI and agent Skill for the
[PentAGI](https://github.com/vxcontrol/pentagi) autonomous penetration-testing
platform.

## API and authentication

The recipe uses PentAGI's native Swagger API. It intentionally excludes the
bundled third-party Langfuse specification.

PentAGI uses a bearer access token:

```sh
pentagi auth login --hostname <host>
pentagi auth status --hostname <host>
```

## Install the Skill

```sh
pentagi skill install --scope user --agent codex --yes
```

## Agent workflow

```sh
pentagi commands --json
pentagi search "list flow tasks" --json
```

Use the returned command path with `pentagi commands show` before execution.
Bump the pin in
`specs/sources.yaml` when upgrading the PentAGI API.

cli:
  name: pentagi
  short: "Command-line tool for the PentAGI security platform"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /api/v1/info
    display:
      username_field: data.user.name
      fallback_field: data.user.mail

name: pentagi
display_name: PentAGI
cli_name: pentagi
category: security
homepage: https://github.com/vxcontrol/pentagi
description: Generated PentAGI CLI and agent Skill for autonomous penetration-testing operations.
maintainers:
  - github: samzong
auth:
  type: bearer
  notes: >-
    Requires a PentAGI access token in the Authorization header. Run
    `pentagi auth login --hostname <host>` and verify it with
    `pentagi auth status --hostname <host>`.
smoke:
  intent: list flow tasks
  expect: get-flows-flow-id-tasks

sources:
  pentagi_api:
    repo_url: https://github.com/vxcontrol/pentagi
    # pinned to master HEAD as of 2026-07-26; bump when upgrading
    pinned_tag: 879e87c2c2688c4a95eac9c1aaf3cd6f6123ebe3
    backend: swagger
    swagger:
      files:
        - backend/pkg/server/docs/swagger.json

generated by lathe codegen; safe to remove and regenerate

---
name: pentagi
description: >
  Use when operating the pentagi generated CLI. Discover commands, inspect parameters,
  check auth state, and execute API operations safely.
---

# pentagi CLI

Use this skill when a user asks you to operate `pentagi`, inspect its API commands, or find the right generated command for an API task.

## Workflow

1. Search for candidates with `pentagi search "<intent>" --json`; use `--limit` when needed. Search is only candidate discovery.
2. Inspect the exact command with `pentagi commands show <path...> --json` before executing an unfamiliar command.
3. If the command detail has `auth.required=true`, run `pentagi auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$PENTAGI_HOST`.
4. Execute only after flags, body, auth, HTTP path, and output hints are clear from `commands show`.

## General Commands

- `pentagi commands --json`: full generated command catalog.
- `pentagi commands --include-hidden --json`: include hidden generated commands.
- `pentagi commands show <path...> --json`: source of truth for one command.
- `pentagi commands schema --json`: catalog schema version for parser compatibility.
- `pentagi search "<intent>" --json`: ranked candidate commands.

## Maintenance Commands

- `pentagi --version` or `pentagi -v`: print CLI build version.

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/pentagi-api.md` for the `pentagi_api` module command index.

## Rules

- Do not guess flags or request body shape from command names.
- Do not execute directly from search results; confirm with `commands show` first.
- Prefer `-o json` for machine-readable command output unless the user asks for human-readable output.
- Use `--file`, `--set`, or `--set-str` for JSON request bodies according to `commands show` body requirements.
- For sensitive flags, prefer safe modes from `flags[].input_modes`: `--<flag>-env`, `--<flag>-file`, or `--<flag>-stdin`.

interface:
  display_name: "pentagi CLI"
  short_description: "Use the pentagi generated CLI"
  default_prompt: "Use $pentagi to find and run the right pentagi command."

# Catalog Protocol

Use the runtime catalog as the source of truth. Generated references are a fast index; command execution details come from the CLI itself.

## Search

Run `pentagi search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `pentagi commands --json` to inspect the generated command catalog. Use `--include-hidden` only when hidden commands are relevant.

Key fields:

- `path`: command path to pass to `commands show` or execute after the CLI name.
- `shortcuts`: root-level commands that execute the same operation with preset flag values.
- `http`: HTTP method and path template.
- `http.default_hostname`: optional source-level host selected after explicit `--hostname` and `$PENTAGI_HOST`; when present it is used before the single-host fallback from `hosts.yml`.
- `flags`: CLI flags, parameter location, type, required state, defaults, enum values, format, input modes, and help.
- `body`: request body requirement and media type.
- `auth`: whether auth is required and which scopes are declared.
- `examples`: runnable examples with optional body shape, output hints, and follow-up commands.
- `output`: list path, default columns, response media type, pagination, and streaming hints.
- `notes`, `prerequisites`, and `known_errors`: overlay-provided operation context that is not inferred from the API spec.

## Command Detail

Run `pentagi commands show <path...> --json` before executing an unfamiliar command. This is the source of truth for flags, body, auth, HTTP path, and output hints.

## Schema

Run `pentagi commands schema --json` to read the catalog schema version before parsing catalog JSON with durable tooling.

## Sensitive Flags

When a flag entry has `input_modes`, prefer safe modes over putting secrets directly in shell arguments.

- `flag`: pass the direct `--<flag>` value; keep this for compatibility or non-secret values.
- `env`: pass `--<flag>-env NAME` to read the value from an environment variable.
- `file`: pass `--<flag>-file path` to read the value from a file.
- `stdin`: pass `--<flag>-stdin` to read the value from stdin.
- Use only one input mode for the same flag.

## Request Bodies

- `--file path`: read a JSON body from a file.
- `--file -`: read a JSON body from stdin.
- `--set key.path=value`: build JSON with type inference for booleans, null, integers, and floats.
- `--set-str key.path=value`: build JSON while forcing the value to remain a string.

## Output

Use `-o json` for machine-readable command output. Other supported formats are `table`, `yaml`, and `raw`.

## Auth

If command detail returns `auth.required=true`, run `pentagi auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$PENTAGI_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

# Module `pentagi_api`

## Source

- Backend: `swagger`
- Repository: https://github.com/vxcontrol/pentagi
- Pinned tag: `879e87c2c2688c4a95eac9c1aaf3cd6f6123ebe3`
- Files: `backend/pkg/server/docs/swagger.json`
- Resolved SHA: `879e87c2c2688c4a95eac9c1aaf3cd6f6123ebe3`

## Agentlogs

### `pentagi agentlogs get-agentlogs`

- Summary: Retrieve agentlogs list
- HTTP: `GET /agentlogs/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi agentlogs get-flows-flow-id-agentlogs`

- Summary: Retrieve agentlogs list by flow id
- HTTP: `GET /flows/{flowID}/agentlogs/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Anonymize

### `pentagi anonymize post-anonymize-text`

- Summary: Anonymize text
- HTTP: `POST /anonymize/text`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

## Assistantlogs

### `pentagi assistantlogs get-assistantlogs`

- Summary: Retrieve assistantlogs list
- HTTP: `GET /assistantlogs/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi assistantlogs get-flows-flow-id-assistantlogs`

- Summary: Retrieve assistantlogs list by flow id
- HTTP: `GET /flows/{flowID}/assistantlogs/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Assistants

### `pentagi assistants delete-flows-flow-id-assistants-assistant-id`

- Summary: Delete assistant by id
- HTTP: `DELETE /flows/{flowID}/assistants/{assistantID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--assistant-id` (path, required): assistant id

### `pentagi assistants get-flows-flow-id-assistants`

- Summary: Retrieve assistants list
- HTTP: `GET /flows/{flowID}/assistants/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi assistants get-flows-flow-id-assistants-assistant-id`

- Summary: Retrieve flow assistant by id
- HTTP: `GET /flows/{flowID}/assistants/{assistantID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--assistant-id` (path, required): assistant id
- Output: response media `application/json`

### `pentagi assistants post-flows-flow-id-assistants`

- Summary: Create new assistant with custom functions
- HTTP: `POST /flows/{flowID}/assistants/`
- Auth: required
- Body: required
- Flags:
  - `--flow-id` (path, required): flow id (use 0 to create a new flow together with the assistant)
- Output: response media `application/json`

### `pentagi assistants put-flows-flow-id-assistants-assistant-id`

- Summary: Patch assistant
- HTTP: `PUT /flows/{flowID}/assistants/{assistantID}`
- Auth: required
- Body: required
- Flags:
  - `--flow-id` (path, required): flow id
  - `--assistant-id` (path, required): assistant id
- Output: response media `application/json`

## Containers

### `pentagi containers get-containers`

- Summary: Retrieve containers list
- HTTP: `GET /containers/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi containers get-flows-flow-id-containers`

- Summary: Retrieve containers list by flow id
- HTTP: `GET /flows/{flowID}/containers/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi containers get-flows-flow-id-containers-container-id`

- Summary: Retrieve container info by id and flow id
- HTTP: `GET /flows/{flowID}/containers/{containerID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--container-id` (path, required): container id
- Output: response media `application/json`

## FlowFiles

### `pentagi flowfiles delete-flows-flow-id-files`

- Summary: Delete flow files or directories by cached paths
- HTTP: `DELETE /flows/{flowID}/files/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--path` (query): relative path in cache: uploads/, resources/, or container/ (may be combined with paths[])
  - `--paths[]` (query): relative paths in cache (repeatable): uploads/, resources/, or container/
- Output: response media `application/json`

### `pentagi flowfiles get-flows-flow-id-files`

- Summary: Retrieve flow files list
- HTTP: `GET /flows/{flowID}/files/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

### `pentagi flowfiles get-flows-flow-id-files-container`

- Summary: Retrieve flow container directory files list
- HTTP: `GET /flows/{flowID}/files/container`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--path` (query): absolute path inside the running container; defaults to /work (may be combined with paths[])
  - `--paths[]` (query): absolute paths inside the running container (repeatable)
- Output: response media `application/json`

### `pentagi flowfiles get-flows-flow-id-files-download`

- Summary: Download flow file(s) or directory by cached path(s)
- HTTP: `GET /flows/{flowID}/files/download`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--path` (query): relative path in cache: uploads/, resources/, or container/ (may be combined with paths[])
  - `--paths[]` (query): relative paths in cache (repeatable)
- Output: response media `application/octet-stream`

### `pentagi flowfiles post-flows-flow-id-files`

- Summary: Upload files to flow workspace
- HTTP: `POST /flows/{flowID}/files/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--files` (formData, required): files to upload (multipart, field name: files or file)
- Output: response media `application/json`

### `pentagi flowfiles post-flows-flow-id-files-pull`

- Summary: Pull files or directories from the running container into the local cache
- HTTP: `POST /flows/{flowID}/files/pull`
- Auth: required
- Body: required
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

### `pentagi flowfiles post-flows-flow-id-files-resources`

- Summary: Copy user resources into a flow
- HTTP: `POST /flows/{flowID}/files/resources`
- Auth: required
- Body: required
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

### `pentagi flowfiles post-flows-flow-id-files-to-resources`

- Summary: Promote flow file(s) or directory/directories to user resources
- HTTP: `POST /flows/{flowID}/files/to-resources`
- Auth: required
- Body: required
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

## Flows

### `pentagi flows delete-flows-flow-id`

- Summary: Delete flow by id
- HTTP: `DELETE /flows/{flowID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id

### `pentagi flows get-flows`

- Summary: Retrieve flows list
- HTTP: `GET /flows/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi flows get-flows-flow-id`

- Summary: Retrieve flow by id
- HTTP: `GET /flows/{flowID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

### `pentagi flows get-flows-flow-id-graph`

- Summary: Retrieve flow graph by id
- HTTP: `GET /flows/{flowID}/graph`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

### `pentagi flows get-flows-flow-id-usage`

- Summary: Retrieve analytics for specific flow
- HTTP: `GET /flows/{flowID}/usage`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

### `pentagi flows post-flows`

- Summary: Create new flow with custom functions
- HTTP: `POST /flows/`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi flows put-flows-flow-id`

- Summary: Patch flow
- HTTP: `PUT /flows/{flowID}`
- Auth: required
- Body: required
- Flags:
  - `--flow-id` (path, required): flow id
- Output: response media `application/json`

## GraphQL

### `pentagi graphql post-graphql`

- Summary: Perform graphql requests
- HTTP: `POST /graphql`
- Auth: required
- Body: required
- Flags: none
- Output: list path `data`; response media `application/json`

## Knowledge

### `pentagi knowledge delete-knowledge-id`

- Summary: Delete knowledge document
- HTTP: `DELETE /knowledge/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Document UUID
- Output: response media `application/json`

### `pentagi knowledge get-knowledge`

- Summary: List knowledge documents
- HTTP: `GET /knowledge/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
  - `--with_content` (query): include document text in the response
- Output: response media `application/json`; pagination `offset`

### `pentagi knowledge get-knowledge-id`

- Summary: Get knowledge document
- HTTP: `GET /knowledge/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Document UUID
- Output: response media `application/json`

### `pentagi knowledge post-knowledge`

- Summary: Create knowledge document
- HTTP: `POST /knowledge/`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi knowledge post-knowledge-search`

- Summary: Semantic search in knowledge base
- HTTP: `POST /knowledge/search`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi knowledge put-knowledge-id`

- Summary: Update knowledge document
- HTTP: `PUT /knowledge/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Document UUID
- Output: response media `application/json`

## Msglogs

### `pentagi msglogs get-flows-flow-id-msglogs`

- Summary: Retrieve msglogs list by flow id
- HTTP: `GET /flows/{flowID}/msglogs/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi msglogs get-msglogs`

- Summary: Retrieve msglogs list
- HTTP: `GET /msglogs/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Prompts

### `pentagi prompts delete-prompts-prompt-type`

- Summary: Delete prompt by type
- HTTP: `DELETE /prompts/{promptType}`
- Auth: required
- Body: none
- Flags:
  - `--prompt-type` (path, required): prompt type
- Output: response media `application/json`

### `pentagi prompts get-prompts`

- Summary: Retrieve prompts list
- HTTP: `GET /prompts/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi prompts get-prompts-prompt-type`

- Summary: Retrieve prompt by type
- HTTP: `GET /prompts/{promptType}`
- Auth: required
- Body: none
- Flags:
  - `--prompt-type` (path, required): prompt type
- Output: response media `application/json`

### `pentagi prompts post-prompts-prompt-type-default`

- Summary: Reset prompt by type to default value
- HTTP: `POST /prompts/{promptType}/default`
- Auth: required
- Body: none
- Flags:
  - `--prompt-type` (path, required): prompt type
- Output: response media `application/json`

### `pentagi prompts put-prompts-prompt-type`

- Summary: Update prompt
- HTTP: `PUT /prompts/{promptType}`
- Auth: required
- Body: required
- Flags:
  - `--prompt-type` (path, required): prompt type
- Output: response media `application/json`

## Providers

### `pentagi providers get-providers`

- Summary: Retrieve providers list
- HTTP: `GET /providers/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## Public

### `pentagi public get-auth-authorize`

- Summary: Login user into OAuth2 external system via HTTP redirect
- HTTP: `GET /auth/authorize`
- Auth: required
- Body: none
- Flags:
  - `--return_uri` (query, default `/`): URI to redirect user there after login
  - `--provider` (query, default `google`): OAuth provider name (google, github, etc.)
- Output: response media `application/json`

### `pentagi public get-auth-login-callback`

- Summary: Login user from external OAuth application
- HTTP: `GET /auth/login-callback`
- Auth: required
- Body: none
- Flags:
  - `--code` (query): Auth code from OAuth provider to exchange token
- Output: response media `application/json`

### `pentagi public get-auth-logout`

- Summary: Logout current user via HTTP redirect
- HTTP: `GET /auth/logout`
- Auth: required
- Body: none
- Flags:
  - `--return_uri` (query, default `/`): URI to redirect user there after logout
- Output: response media `application/json`

### `pentagi public get-info`

- Summary: Retrieve current user and system settings
- HTTP: `GET /info`
- Auth: required
- Body: none
- Flags:
  - `--refresh_cookie` (query): boolean arg to refresh current cookie, use explicit false
- Output: response media `application/json`

### `pentagi public post-auth-login`

- Summary: Login user into system
- HTTP: `POST /auth/login`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi public post-auth-login-callback`

- Summary: Login user from external OAuth application
- HTTP: `POST /auth/login-callback`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi public post-auth-logout-callback`

- Summary: Logout current user from external OAuth application
- HTTP: `POST /auth/logout-callback`
- Auth: required
- Body: none
- Flags: none

## Resources

### `pentagi resources delete-resources`

- Summary: Delete a resource (file or directory)
- HTTP: `DELETE /resources/`
- Auth: required
- Body: none
- Flags:
  - `--path` (query): virtual path to delete (may be combined with paths[])
  - `--paths[]` (query): additional virtual paths to delete (repeatable)
- Output: response media `application/json`

### `pentagi resources get-resources`

- Summary: List user resources
- HTTP: `GET /resources/`
- Auth: required
- Body: none
- Flags:
  - `--path` (query): virtual directory path; empty for root (may be combined with paths[])
  - `--paths[]` (query): additional virtual directory paths (repeatable)
  - `--recursive` (query): list recursively (default false)
- Output: response media `application/json`

### `pentagi resources get-resources-download`

- Summary: Download a resource or resources
- HTTP: `GET /resources/download`
- Auth: required
- Body: none
- Flags:
  - `--path` (query): virtual path to download (may be combined with paths[])
  - `--paths[]` (query): additional virtual paths to download (repeatable)
- Output: response media `application/octet-stream`

### `pentagi resources post-resources`

- Summary: Upload files to resource storage
- HTTP: `POST /resources/`
- Auth: required
- Body: none
- Flags:
  - `--dir` (query): target virtual directory path; empty or omitted means root
  - `--files` (formData, required): files to upload (field name: files or file)
- Output: response media `application/json`

### `pentagi resources post-resources-copy`

- Summary: Copy resource(s) (files or directories)
- HTTP: `POST /resources/copy`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi resources post-resources-mkdir`

- Summary: Create a virtual directory
- HTTP: `POST /resources/mkdir`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi resources put-resources-move`

- Summary: Move or rename resource(s) (files or directories)
- HTTP: `PUT /resources/move`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

## Roles

### `pentagi roles get-roles`

- Summary: Retrieve roles list
- HTTP: `GET /roles/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi roles get-roles-role-id`

- Summary: Retrieve role by id
- HTTP: `GET /roles/{roleID}`
- Auth: required
- Body: none
- Flags:
  - `--role-id` (path, required): role id
- Output: response media `application/json`

## Screenshots

### `pentagi screenshots get-flows-flow-id-screenshots`

- Summary: Retrieve screenshots list by flow id
- HTTP: `GET /flows/{flowID}/screenshots/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi screenshots get-flows-flow-id-screenshots-screenshot-id`

- Summary: Retrieve screenshot info by id and flow id
- HTTP: `GET /flows/{flowID}/screenshots/{screenshotID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--screenshot-id` (path, required): screenshot id
- Output: response media `application/json`

### `pentagi screenshots get-flows-flow-id-screenshots-screenshot-id-file`

- Summary: Retrieve screenshot file by id and flow id
- HTTP: `GET /flows/{flowID}/screenshots/{screenshotID}/file`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--screenshot-id` (path, required): screenshot id
- Output: response media `image/png`

### `pentagi screenshots get-screenshots`

- Summary: Retrieve screenshots list
- HTTP: `GET /screenshots/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Searchlogs

### `pentagi searchlogs get-flows-flow-id-searchlogs`

- Summary: Retrieve searchlogs list by flow id
- HTTP: `GET /flows/{flowID}/searchlogs/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi searchlogs get-searchlogs`

- Summary: Retrieve searchlogs list
- HTTP: `GET /searchlogs/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Settings

### `pentagi settings get-settings`

- Summary: Retrieve settings
- HTTP: `GET /settings/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## Subtasks

### `pentagi subtasks get-flows-flow-id-subtasks`

- Summary: Retrieve flow subtasks list
- HTTP: `GET /flows/{flowID}/subtasks/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi subtasks get-flows-flow-id-tasks-task-id-subtasks`

- Summary: Retrieve flow task subtasks list
- HTTP: `GET /flows/{flowID}/tasks/{taskID}/subtasks/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--task-id` (path, required): task id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi subtasks get-flows-flow-id-tasks-task-id-subtasks-subtask-id`

- Summary: Retrieve flow task subtask by id
- HTTP: `GET /flows/{flowID}/tasks/{taskID}/subtasks/{subtaskID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--task-id` (path, required): task id
  - `--subtask-id` (path, required): subtask id
- Output: response media `application/json`

## Tasks

### `pentagi tasks get-flows-flow-id-tasks`

- Summary: Retrieve flow tasks list
- HTTP: `GET /flows/{flowID}/tasks/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi tasks get-flows-flow-id-tasks-task-id`

- Summary: Retrieve flow task by id
- HTTP: `GET /flows/{flowID}/tasks/{taskID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--task-id` (path, required): task id
- Output: response media `application/json`

### `pentagi tasks get-flows-flow-id-tasks-task-id-graph`

- Summary: Retrieve flow task graph by id
- HTTP: `GET /flows/{flowID}/tasks/{taskID}/graph`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--task-id` (path, required): task id
- Output: response media `application/json`

## Termlogs

### `pentagi termlogs get-flows-flow-id-termlogs`

- Summary: Retrieve termlogs list by flow id
- HTTP: `GET /flows/{flowID}/termlogs/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi termlogs get-termlogs`

- Summary: Retrieve termlogs list
- HTTP: `GET /termlogs/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Tokens

### `pentagi tokens delete-tokens-token-id`

- Summary: Delete API token
- HTTP: `DELETE /tokens/{tokenID}`
- Auth: required
- Body: none
- Flags:
  - `--token-id` (path, required): Token ID
- Output: response media `application/json`

### `pentagi tokens get-tokens`

- Summary: List API tokens
- HTTP: `GET /tokens`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `pentagi tokens get-tokens-token-id`

- Summary: Get API token details
- HTTP: `GET /tokens/{tokenID}`
- Auth: required
- Body: none
- Flags:
  - `--token-id` (path, required): Token ID
- Output: response media `application/json`

### `pentagi tokens post-tokens`

- Summary: Create new API token for automation
- HTTP: `POST /tokens`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi tokens put-tokens-token-id`

- Summary: Update API token
- HTTP: `PUT /tokens/{tokenID}`
- Auth: required
- Body: required
- Flags:
  - `--token-id` (path, required): Token ID
- Output: response media `application/json`

## Toolcalls

### `pentagi toolcalls get-flows-flow-id-toolcalls`

- Summary: Retrieve toolcalls list by flow id
- HTTP: `GET /flows/{flowID}/toolcalls/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi toolcalls get-flows-flow-id-toolcalls-toolcall-id`

- Summary: Retrieve toolcall info by id and flow id
- HTTP: `GET /flows/{flowID}/toolcalls/{toolcallID}`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--toolcall-id` (path, required): toolcall id
- Output: response media `application/json`

### `pentagi toolcalls get-toolcalls`

- Summary: Retrieve toolcalls list
- HTTP: `GET /toolcalls/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

## Usage

### `pentagi usage get-usage`

- Summary: Retrieve system-wide analytics
- HTTP: `GET /usage`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `pentagi usage get-usage-period`

- Summary: Retrieve analytics for specific time period
- HTTP: `GET /usage/{period}`
- Auth: required
- Body: none
- Flags:
  - `--period` (path, required, one of: week|month|quarter): period
- Output: response media `application/json`

## Users

### `pentagi users delete-users-hash`

- Summary: Delete user by hash
- HTTP: `DELETE /users/{hash}`
- Auth: required
- Body: none
- Flags:
  - `--hash` (path, required): hash in hex format (md5)
- Output: response media `application/json`

### `pentagi users get-user`

- Summary: Retrieve current user information
- HTTP: `GET /user/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `pentagi users get-users`

- Summary: Retrieve users list by filters
- HTTP: `GET /users/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi users get-users-hash`

- Summary: Retrieve user by hash
- HTTP: `GET /users/{hash}`
- Auth: required
- Body: none
- Flags:
  - `--hash` (path, required): hash in hex format (md5)
- Output: response media `application/json`

### `pentagi users post-users`

- Summary: Create new user
- HTTP: `POST /users/`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi users put-user-password`

- Summary: Update password for current user (account)
- HTTP: `PUT /user/password`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `pentagi users put-users-hash`

- Summary: Update user
- HTTP: `PUT /users/{hash}`
- Auth: required
- Body: required
- Flags:
  - `--hash` (path, required): user hash in hex format (md5)
- Output: response media `application/json`

## Vecstorelogs

### `pentagi vecstorelogs get-flows-flow-id-vecstorelogs`

- Summary: Retrieve vecstorelogs list by flow id
- HTTP: `GET /flows/{flowID}/vecstorelogs/`
- Auth: required
- Body: none
- Flags:
  - `--flow-id` (path, required): flow id
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`

### `pentagi vecstorelogs get-vecstorelogs`

- Summary: Retrieve vecstorelogs list
- HTTP: `GET /vecstorelogs/`
- Auth: required
- Body: none
- Flags:
  - `--filters[]` (query): Filtering result on server e.g. {"value":[...],"field":"...","operator":"..."}
  - `--group` (query): Field to group results by
  - `--page` (query, required, default `1`): Number of page (since 1)
  - `--page-size` (query, default `5`): Amount items per page (min -1, max 1000, -1 means unlimited)
  - `--sort[]` (query): Sorting result on server e.g. {"prop":"...","order":"..."}
  - `--type` (query, required, default `init`, one of: sort|filter|init|page|size): Type of request
- Output: response media `application/json`; pagination `offset`