Skip to content

Quick Start

If you want to verify Skylattice without API keys, this is the page to use.

The zero-credential path proves the runtime boots, the tracked validation commands are real, and the repository contains public-safe proof artifacts before you trust it with real tokens.

Key Takeaways

  • The fastest success path is install -> doctor -> pytest -> validation suite.
  • You do not need OPENAI_API_KEY or GITHUB_TOKEN to verify the stable public release.
  • The expected outputs are documented, so you can compare your local results with public-safe samples.

What You Prove In Five Minutes

  • the local runtime boots and exposes a real state surface
  • the tracked validation commands are executable and aligned with CI
  • the repository ships public-safe proof artifacts that match the documented workflows

What You Are Not Proving Yet

  • live OpenAI planning or edit generation
  • live GitHub or GitLab discovery, or GitHub pull-request / issue-comment sync
  • whether Skylattice already fits your production workflow without further configuration

Fastest Product Preview

If you want the web product surface before any live auth or pairing setup, run:

npm install
npm run web:preview

Then open http://localhost:3000/dashboard. The preview is read-only and seeded with representative task, radar, memory, command, device, and approval data.

That preview is deliberately different from Hosted Alpha live usage. Hosted Alpha adds a real public app URL, GitHub sign-in, real pairing, and Postgres-backed control-plane state, while the local agent still executes the work.

For a maintainer-facing proof loop that checks this boundary without live OAuth, Neon, or a paired connector, run:

npm run web:first-run:local

5-Minute No-Credential Verification

  1. Install the project.
python -m pip install -e .[dev]
  1. Verify local runtime health.
python -m skylattice.cli doctor

Expected: a JSON report like doctor-output.json showing status: ok, the local SQLite path, and the tracked validation commands.

  1. Run smoke tests.
python -m pytest -q

Expected: the repository smoke tests pass without requiring cloud credentials.

  1. Run the public validation suite.
python tools/run_validation_suite.py

Expected: the Windows-first validation baseline from configs/task/validation.yaml passes and reports the same tracked commands that CI uses.

  1. Inspect public-safe sample outputs.

  2. Task walkthrough

  3. Task inspect JSON
  4. Radar walkthrough
  5. Radar inspect JSON

Success Criteria

You have a believable first-run result when:

  • doctor reports status: ok
  • the smoke tests and validation suite pass locally
  • the sample JSON structures look consistent with your local outputs

Token-Enabled Path

If you prefer a product-shaped surface over raw CLI commands, the repository now also includes a hosted control-plane app foundation under apps/web/README.md. The app handles sign-in, pairing, and browser command intent, while the paired local runtime still executes the real work. For the public deployment contract, use Hosted Alpha Runbook.

PowerShell example:

$env:OPENAI_API_KEY = "..."
$env:GITHUB_TOKEN = "..."
$env:SKYLATTICE_GITHUB_REPOSITORY = "YSCJRH/skylattice"

Read-only preflight first:

python -m skylattice.cli doctor auth

If gh auth status is already green and you want explicit exports for the current shell:

python -m skylattice.cli doctor github-bridge --format env

Skylattice does not silently consume gh login state. The runtime still expects explicit env vars or tracked config.

Optional read-only smoke before real task or radar runs:

python tools/run_authenticated_smoke.py --provider github
python tools/run_authenticated_smoke.py --provider gitlab
python tools/run_authenticated_smoke.py --provider openai
python -m skylattice.cli web status

What that proves:

  • your live GitHub adapter can read repository metadata without mutating anything
  • your live GitLab adapter can read project metadata without mutating anything
  • your live OpenAI adapter can complete a minimal structured response round-trip
  • your preflight report can distinguish gh login state from runtime-ready Skylattice credentials
  • your local connector can report whether it is paired to a hosted control plane before you try browser-triggered operations

Representative commands:

skylattice task run --goal "Refresh README and prepare a draft PR" --allow repo-write --allow external-write
skylattice radar scan --window weekly --limit 20

Use the read-only smoke first if you want to separate credential wiring from full task or radar behavior.