Skip to main content
Print a read-only setup plan for a goal without an account, ledger or network.

​
Example

Prints a JSON setup plan. Hosted mode skips local workspace inspection; the command writes no files and makes no requests.

​
Options

--plan required. --goal verify-links, prepare-campaign or build-content required. --mode local (default), hosted or external. Any other option, a repeated option or a positional argument is a usage error.

​
Exit status

0 on success; 2 on usage error.
Prints one JSON object (schemaVersion 1, kind setup_plan) with the goal, mode, a known-path inspection of the selected workspace, capabilities, ordered steps, warnings and an effects block that is always zero. Inspection is metadata only: it reports each standard path (.git, the .agentlinkops/ and legacy .linktrail/ ledger files, SITE.md locations, a backlink registry CSV, a CRM SQLite file and the installed plugin directory) as file, directory, missing, symlink, blocked or unreadable without following symlinks, reading contents or resolving custom paths.Hosted mode skips inspection entirely. Steps name who executes them (customer_local, customer_agent, agentlinkops_hosted or customer_external), what they require and what evidence they should produce; a workspace finding adds a resolve-workspace-findings step first.Nothing is written and no request is made.
Read configuration and file ownership for environment variables, compatibility aliases and writer locks. Read local file contracts for artifact fields. Browse the CLI index for related commands.
Check the selected environment and workspace access before calling hosted operations. See capability status.

​
Plan fields

Inspection is skipped with a reason in hosted mode. Otherwise it has status known_path_metadata, workspace.status, paths (path/status pairs) and coverage. Metadata states are file, directory, symlink, blocked, unreadable or missing. Coverage explicitly records contentsRead:false, recursiveDiscovery:false and customPathsResolved:false. Capabilities reports localCli:available, cloudConnection:unverified and vendorConnections:unverified. A file being present does not verify an installation, connection or record. Each step has id, execution, action, requires and expectedEvidence. Execution labels describe a later actor; no step has run. Warnings include WORKSPACE_INSPECTION_INCOMPLETE, UNSAFE_OR_UNREADABLE_PATH, UNEXPECTED_PATH_TYPE and CUSTOM_PATHS_UNRESOLVED where applicable. Each warning has code and message, plus path when tied to a known path. Effects records filesWritten, networkRequests, accountsConnected and messagesSent, all zero.