Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mindfort.ai/llms.txt

Use this file to discover all available pages before exploring further.

The MindFort CLI provides terminal access to the MindFort platform for local workflows, CI jobs, and agent-driven automation. The CLI always connects to the production MindFort API at https://api.mindfort.app.

Install

Install with Go:
go install github.com/mindfortai/mindfort-cli/cmd/mindfort@latest
Or download a release binary from the MindFort CLI GitHub repository.

Authenticate

Create an API key in the MindFort dashboard, then store it in your OS keychain:
mindfort auth set-key --api-key <api-key>
For CI and scripts, use an environment variable:
export MINDFORT_API_KEY=<api-key>
You can also read the key from standard input:
printf '%s' "$MINDFORT_API_KEY" | mindfort auth set-key --stdin
Check authentication status:
mindfort auth status

Assessments

Run an assessment:
mindfort assessment run --target-id <target-id> --method turbo
Preview the request without creating an assessment:
mindfort assessment run --target-id <target-id> --method turbo --dry-run --json
List assessments:
mindfort assessment list --status active --limit 25
Cancel an assessment:
mindfort assessment cancel <assessment-id>

Tasks

Start an autonomous task:
mindfort task run --target-id <target-id> --message "Check the login flow for auth bypasses"
Preview the task request without starting it:
mindfort task run --target-id <target-id> --message "Check auth" --dry-run --json
Run a saved task template:
mindfort task run-template <template-id>
Cancel a task:
mindfort task cancel <task-id>

Findings

List findings for a target:
mindfort findings list --target-id <target-id> --severity high --limit 25
Use --json for machine-readable output:
mindfort findings list --target-id <target-id> --json

Automation

The CLI is designed for non-interactive use:
  • Pass all inputs as flags.
  • Use --json for structured output.
  • Use --no-banner to suppress decorative output in scripts.
  • Use --dry-run before create operations when you want to preview requests.
  • Use MINDFORT_API_KEY instead of storing secrets on CI runners.
Example:
mindfort findings list --target-id <target-id> --json --no-banner