SimetrikDocs
Guides

Onboarding and autocompletion

Onboarding and autocompletion

Goal: go from zero to a running reconciliation project in minutes, and make the terminal comfortable for humans and agents alike. These commands are local: they work without login.

Autocomplete commands (completion)

Print the autocompletion script for your shell:

simetrik completion zsh   # or bash | fish | pwsh

To install it, redirect the output to your shell's completion file. With no argument, simetrik completion tries to detect your shell from $SHELL.

Bootstrap a project (samples / init)

List the available project templates:

simetrik samples
simetrik --output json samples   # structured data for an agent

Create a project from a template:

simetrik init basic-recon ./my-project

init leaves at least one declarative playbook and a ready-to-run README. For safety, it refuses to overwrite a non-empty directory unless you pass --force.

simetrik --output json init basic-recon ./my-project
# → {"schema_version":"1","template":"basic-recon","target":"./my-project","files":[...]}

Jump to the web app (open)

Open a resource or the dashboard in the browser:

simetrik open dashboard
simetrik open <resource-id>

For a headless agent (no browser), request only the URL:

simetrik open <resource-id> --print-url
simetrik --output json open dashboard   # → {"schema_version":"1","url":"https://app..."}

completion, samples, init, and open don't require authentication — use them before simetrik login.

On this page