# KinoSec CLI

> Official command-line interface for KinoSec, the white-label autonomous pentesting platform for MSPs, MSSPs, and IT providers.

Run pentests, manage assets, view findings, export reports, and schedule recurring scans from the terminal.

- Package: `@kinosec/cli` (npm)
- Binary: `kinosec`
- Requires: Node.js 20+
- Auth: Personal Access Tokens (prefix `kns_`)

## Documentation

### Getting Started

- [Overview](https://kinosec.ai/docs/cli/overview): What the CLI does and how to get started.
- [Installation](https://kinosec.ai/docs/cli/install): Install via curl or npm.
- [Quick Start](https://kinosec.ai/docs/cli/quickstart): Run your first pentest in 5 minutes.
- [Authentication](https://kinosec.ai/docs/cli/authentication): Create tokens, log in, token resolution order.

### Guides

- [Authenticated Pentesting](https://kinosec.ai/docs/cli/guides/authenticated-pentesting): Configure credentials for deeper scans and access control testing.
- [Recurring Scans](https://kinosec.ai/docs/cli/guides/recurring-scans): Schedule daily, weekly, or monthly pentests.
- [Triaging Findings](https://kinosec.ai/docs/cli/guides/triaging-findings): Review, classify, and resolve findings.

### Reference

- [Exit Codes](https://kinosec.ai/docs/cli/exit-codes): Exit codes returned by the CLI.

### Command Reference

#### auth
- [auth login](https://kinosec.ai/docs/cli/reference/auth/login): Authenticate with a KinoSec API token.
- [auth status](https://kinosec.ai/docs/cli/reference/auth/status): Show current authentication status.
- [auth logout](https://kinosec.ai/docs/cli/reference/auth/logout): Remove stored credentials.

#### me
- [me](https://kinosec.ai/docs/cli/reference/me): Show authenticated user info.

#### credits
- [credits](https://kinosec.ai/docs/cli/reference/credits): Show your credit balance.

#### asset
- [asset list](https://kinosec.ai/docs/cli/reference/asset/list): List assets.
- [asset get](https://kinosec.ai/docs/cli/reference/asset/get): Get asset details.
- [asset create](https://kinosec.ai/docs/cli/reference/asset/create): Create a new asset.
- [asset delete](https://kinosec.ai/docs/cli/reference/asset/delete): Delete an asset.
- [asset scope](https://kinosec.ai/docs/cli/reference/asset/scope): View or configure subdomain scope.

#### asset auth
- [asset auth set](https://kinosec.ai/docs/cli/reference/asset/auth/set): Configure authentication credentials for an asset.
- [asset auth show](https://kinosec.ai/docs/cli/reference/asset/auth/show): Show authentication configuration.
- [asset auth remove](https://kinosec.ai/docs/cli/reference/asset/auth/remove): Remove authentication credentials.
- [asset auth set-target](https://kinosec.ai/docs/cli/reference/asset/auth/set-target): Configure IDOR target account credentials.
- [asset auth remove-target](https://kinosec.ai/docs/cli/reference/asset/auth/remove-target): Remove target account credentials.

#### pentest
- [pentest](https://kinosec.ai/docs/cli/reference/pentest): Run a pentest.
- [pentest list](https://kinosec.ai/docs/cli/reference/pentest/list): List pentests.
- [pentest get](https://kinosec.ai/docs/cli/reference/pentest/get): Get pentest details.
- [pentest cancel](https://kinosec.ai/docs/cli/reference/pentest/cancel): Cancel a running pentest.
- [pentest watch](https://kinosec.ai/docs/cli/reference/pentest/watch): Watch pentest progress in real-time.

#### pentest schedule
- [schedule list](https://kinosec.ai/docs/cli/reference/pentest/schedule/list): List scheduled pentests.
- [schedule get](https://kinosec.ai/docs/cli/reference/pentest/schedule/get): Get schedule details.
- [schedule create](https://kinosec.ai/docs/cli/reference/pentest/schedule/create): Create a scheduled pentest.
- [schedule update](https://kinosec.ai/docs/cli/reference/pentest/schedule/update): Update a schedule.
- [schedule delete](https://kinosec.ai/docs/cli/reference/pentest/schedule/delete): Delete a schedule.
- [schedule pause](https://kinosec.ai/docs/cli/reference/pentest/schedule/pause): Pause a scheduled pentest.
- [schedule resume](https://kinosec.ai/docs/cli/reference/pentest/schedule/resume): Resume a paused schedule.

#### finding
- [finding list](https://kinosec.ai/docs/cli/reference/finding/list): List findings.
- [finding get](https://kinosec.ai/docs/cli/reference/finding/get): Get finding details.
- [finding update](https://kinosec.ai/docs/cli/reference/finding/update): Update finding status.
- [finding retest](https://kinosec.ai/docs/cli/reference/finding/retest): Trigger a retest for a finding.

#### report
- [report list](https://kinosec.ai/docs/cli/reference/report/list): List reports.
- [report get](https://kinosec.ai/docs/cli/reference/report/get): Get report details.
- [report export](https://kinosec.ai/docs/cli/reference/report/export): Export a report.

#### token
- [token list](https://kinosec.ai/docs/cli/reference/token/list): List API tokens.
- [token create](https://kinosec.ai/docs/cli/reference/token/create): Create a new API token.
- [token revoke](https://kinosec.ai/docs/cli/reference/token/revoke): Revoke an API token.

## Full Documentation

For the complete text of all documentation pages, see [llms-full.txt](https://kinosec.ai/llms-full.txt).