Skip to content

Quickstart

1. Initialize a project

neksus-jobspec init

This creates .neksus/config.yaml, jobspecs/, and dist/.

2. Create a JobSpec

neksus-jobspec spec new backend-engineer

3. Validate

neksus-jobspec spec validate jobspecs/backend-engineer.jobspec.yaml

Use strict mode to fail on warnings:

neksus-jobspec spec validate jobspecs/backend-engineer.jobspec.yaml --strict

4. Render

neksus-jobspec spec render jobspecs/backend-engineer.jobspec.yaml --format markdown --output dist/backend-engineer.md
neksus-jobspec spec render jobspecs/backend-engineer.jobspec.yaml --format html --theme modern --output dist/backend-engineer.html
neksus-jobspec spec render jobspecs/backend-engineer.jobspec.yaml --format json --output dist/backend-engineer.json

5. Project checks

neksus-jobspec check
neksus-jobspec check --format github
neksus-jobspec check --strict

6. Batch render

neksus-jobspec render --format markdown
neksus-jobspec render --format html --theme modern

For all commands and options, see CLI Reference.