Skip to content

Getting Started

This section gets Atlas running with real commands and real repository fixtures.

The goal is not to teach every feature. The goal is to give you a successful first run that makes the rest of the documentation meaningful.

The First-Run Path

flowchart TD
    A[Install and verify] --> B[Run Atlas locally]
    B --> C[Load a sample dataset]
    C --> D[Publish and promote into a serving store]
    D --> E[Start the server]
    E --> F[Run first queries]
    F --> G[Troubleshoot early problems if needed]

This sequence is intentionally linear. It gives first-time readers one reliable path to a successful local run instead of asking them to assemble a workflow from scattered pages.

What You Will Have at the End

  • a working Atlas CLI invocation
  • a sample build root under artifacts/
  • a sample serving store under artifacts/
  • a running local Atlas server
  • successful queries against the local runtime
flowchart LR
    Fixtures[Repo fixtures] --> Build[Local ingest build root]
    Build --> Publish[Publish and catalog promote]
    Publish --> Store[Serving store under artifacts/]
    Store --> Server[Local server]
    Server --> Queries[First queries]

This diagram shows the state you should expect to create, not just the commands you should run. That matters because Atlas separates build outputs, serving store state, and runtime behavior.

Pages in This Section

flowchart LR
    GS[Getting Started] --> Install[Install]
    GS --> Local[Run locally]
    GS --> Sample[Load sample]
    GS --> Server[Start server]
    GS --> Query[First queries]
    GS --> Trouble[Troubleshoot]

This section map is useful when you return later. It tells you which page to reopen when you need to repeat only part of the first-run path.

Ground Rules

  • commands prefer repository-relative paths so you can follow them from the workspace root
  • sample data comes from committed test fixtures rather than invented fake commands
  • output roots go under artifacts/, not inside crate directories

What This Section Deliberately Does Not Cover

  • production deployment topologies
  • every query shape or advanced runtime flag
  • deep architecture rationale for maintainers

Those topics matter, but they come later in the docs spine after you have a working local baseline.

Purpose

This page explains the Atlas material for getting started and points readers to the canonical checked-in workflow or boundary for this topic.

Stability

This page is part of the canonical Atlas docs spine. Keep it aligned with the current repository behavior and adjacent contract pages.