Skip to content
Scryr

CLI reference

Run commands from the repository containing index.scry.

Primary workflows

Section titled “Primary workflows”
Terminal window
scryr check
scryr format
scryr lint --fix
scryr push
scryr serve --watch
scryr report tests --run-id "$GITHUB_RUN_ID" --observed-at "$RESULTS_COMPLETED_AT"
scryr report actions
scryr query --list
scryr query request_latency --json

Check, format, and lint

Section titled “Check, format, and lint”

scryr check

Section titled “scryr check”

Checks formatting, lint, Python types, manifest execution, serialization, and Scryr diagram rules. It requires at least one public Diagram, unique diagram identifiers, and valid references to public Manifest objects.

check does not rewrite source or contact Scryr/provider APIs. Manifest execution itself runs user Python code and can have whatever side effects that code defines.

scryr format

Section titled “scryr format”

Rewrites the entrypoint and reachable local .scry/.py imports. Use scryr format --check for a non-writing check.

scryr lint

Section titled “scryr lint”

Reports lint errors. scryr lint --fix applies safe fixes. Existing Ruff configuration is honored, and .scry files are treated as Python.

Serve locally

Section titled “Serve locally”
Terminal window
scryr serve
scryr serve --watch --port 9000
scryr serve --no-format --no-open
scryr serve --server-only --sample mern

serve starts the embedded map and GraphQL server, waits for readiness, formats and checks the source, uploads the artifact, and opens the browser.

  • --watch: repeat after source changes.
  • --server-only: do not read, format, execute, or upload a local manifest.
  • --no-format: verify formatting without changing files.
  • --no-open: do not launch a browser.
  • --host: bind interface; default 127.0.0.1.
  • --port: TCP port; default 8000.
  • --sample: select a persisted sample artifact.
  • --auth-mode: local or clerk.

Shared path options

Section titled “Shared path options”

These apply to check, format, lint, push, serve, export, inspect, and query:

--path <file>          Manifest file. Defaults to index.scry.
--manifest-dir <dir>   Manifest project root. Defaults to the current directory.
--scryr-dir <dir>      Scryr-managed local state directory.

Push

Section titled “Push”

scryr push validates the manifest, generates schema and diagram artifacts, and persists them through the configured GraphQL API.

Terminal window
scryr push --path index.scry

Local endpoints use tokenless local authentication. Hosted Clerk-backed endpoints require scryr auth login first.

Endpoint precedence is --endpoint, SCRYR_ENDPOINT, legacy SCRYR_GRAPHQL_URL, then loopback using PORT or port 8000.

Inspect

Section titled “Inspect”
Terminal window
scryr inspect types --path index.scry
scryr inspect schema --path index.scry

inspect types prints declared and runtime field metadata. inspect schema prints the Pydantic JSON schema for Manifest, Forge, and Diagram.

Export

Section titled “Export”
Terminal window
scryr export mise --forge "Developer environment"
scryr export compose --forge "Developer environment"
scryr export devcontainer --forge "Developer environment"

Compose export currently supports PostgreSQL, MongoDB, Redis, MySQL, and MariaDB service tools declared in a Forge.

Authentication

Section titled “Authentication”
Terminal window
scryr auth login
scryr auth whoami
scryr auth logout

Local use needs no cloud login. Authentication commands manage the OAuth token used for hosted uploads.