Getting started

This walkthrough goes from install to a configured workspace in a few minutes. For a single-command taste of the product, the README's 60-second check is the shortest path; this page continues past it.

1. Install The CLI

cargo install omena-cli --locked

Editor users can install the VS Code extension instead; both run the same engine.

2. Lint A File With Zero Config

Every product verb works without configuration:

omena lint src/button.module.css

Findings are typed and carry evidence — the report names the rule, the span, and why the engine believes it (for example, a missing-keyframes finding names the animation reference that has no matching @keyframes in scope).

3. Add A Workspace Config

Create omena.toml at the workspace root. The fastest start is extending a built-in persona preset, then overriding only what you need:

extends = "omena:workspace-maintenance"

[lint]
profile = "strict"

Presets choose sensible verb defaults per audience — see the persona reference and the configuration reference for every key. Public TOML fences in these docs are executed against the real config parser in CI.

4. Ask The Workspace Questions

omena modules emit
omena explain cascade --line 0 --character 8 src/button.module.css

modules emit writes deterministic TypeScript declarations and a module-interface manifest for the workspace (modules check verifies the committed output byte-for-byte). omena explain answers "why" questions — explain cascade shows which declaration wins at a source position and the evidence behind it; other subcommands explain diagnostics, transform decisions, precision, and tree-shaking retention.

5. Where To Go Next

• Browser playground — run the Rust engine without installing a package.
• SDK workflows — the same engine from NAPI, WASM, CLI, and LSP.
• Sass compatibility — SIF adoption and provenance tiers.
• Codemods — plan-first migrations with typed rollback.
• Editor setup — VS Code, Zed, Neovim, or any LSP client.