CLI Documentation

AutoSEOSystem publishes a lightweight official CLI installer script for agents and developers who want to call the public API from shell automation.

The CLI documentation explains how to discover public plan data, verify sandbox connectivity, inspect the OpenAPI document, and prepare authenticated widget audit requests when an organization has issued a scoped API key.

Install

Download the script from https://autoseosystem.ai/cli/autoseosystem and place it on your PATH as `autoseosystem`.

The script is intentionally small so teams can review it before use, pin it in deployment tooling, or adapt the same request pattern in their own automation. It does not replace the web application; it gives agents and developers a predictable shell entry point for public API checks.

Commands

- `autoseosystem plans` calls GET /api/v1/plans.

- `autoseosystem sandbox` calls GET /api/v1/sandbox/health without authentication.

- `autoseosystem openapi` prints the OpenAPI JSON document.

- `autoseosystem widget-audit URL EMAIL` creates a widget audit when `AUTOSEOSYSTEM_API_KEY` is set.

Authentication

Set `AUTOSEOSYSTEM_API_KEY` for scoped widget audit calls. Public plan and sandbox commands require no authentication.

Keep API keys in environment variables or a managed secret store rather than hard-coding them in scripts, repositories, tickets, or shared documents. Public commands can be used without a key, but audit creation requires an API key with the correct scope for the connected organization.

When to use the CLI

Use the AutoSEOSystem CLI when you need a quick machine-readable check from a terminal, build pipeline, monitoring job, agent workflow, or integration test. Common uses include confirming the production API is reachable, reading current public plan metadata, printing the OpenAPI document for a client generator, or creating a website audit from an approved widget integration.

Related resources

- Developer resources: https://autoseosystem.ai/developers

- OpenAPI specification: https://autoseosystem.ai/openapi.json

- OAuth authorization server metadata: https://autoseosystem.ai/.well-known/oauth-authorization-server

- OAuth protected resource metadata: https://autoseosystem.ai/.well-known/oauth-protected-resource

- Brand and entity resource: https://autoseosystem.ai/brand

Usage limits

The CLI follows the same API behavior as direct HTTP requests. Rate limits, authentication errors, validation errors, and permission checks are returned by the API response. AutoSEOSystem does not guarantee search rankings, indexing, traffic, AI citations, backlink placement, or revenue outcomes through the CLI or any automation workflow.