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.

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

PowerShell example:

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

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