Skip to content

CLI Reference

Use neksus-jobspec --help and neksus-jobspec <command> --help for inline help.

version

Purpose: Show installed CLI version.

Syntax:

neksus-jobspec version [--json]

Options:

  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec version
neksus-jobspec version --json

JSON notes: --json returns { "name": "neksus-jobspec", "version": "..." }.

init

Purpose: Initialize a project in current directory.

Syntax:

neksus-jobspec init [--empty] [--force] [--json]

Options:

  • --empty: Skip creating example JobSpec.
  • --force: Overwrite existing project config/example files.
  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec init
neksus-jobspec init --empty
neksus-jobspec init --force --json

spec new

Purpose: Create a new JobSpec file from a template.

Syntax:

neksus-jobspec spec new NAME [--template TEMPLATE] [--output PATH] [--force] [--json]

Options:

  • --template: One of built-in templates.
  • --output: Write to explicit path.
  • --force: Overwrite if target exists.
  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec spec new backend-engineer
neksus-jobspec spec new sales-lead --template sales
neksus-jobspec spec new product-manager --output jobspecs/pm.jobspec.yaml --json

spec validate

Purpose: Validate one JobSpec file.

Syntax:

neksus-jobspec spec validate PATH [--strict] [--json]

Options:

  • --strict: Treat warnings as failures.
  • --json: Emit machine-readable JSON.

Examples:

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

spec render

Purpose: Render one JobSpec into web/json-ld.

Syntax:

neksus-jobspec spec render PATH [--format FORMAT] [--theme THEME] [--asset-base-url URL_OR_PATH] [--output PATH] [--no-validate] [--json]

Options:

  • --format: web, json-ld.
  • --theme: Built-in render theme.
  • --asset-base-url: Prefix relative component asset URLs in rendered web output (web only).
  • --output: Write rendered content to file.
  • --no-validate: Skip validation before rendering.
  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec spec render jobspecs/backend-engineer.jobspec.yaml --format web
neksus-jobspec spec render jobspecs/backend-engineer.jobspec.yaml --format web --theme soft-professional
neksus-jobspec spec render jobspecs/backend-engineer.jobspec.yaml --format json-ld --output dist/backend-engineer.json --json

JSON notes: includes render metadata and either content (stdout mode) or output path (file mode).

spec status

Purpose: Show campaign status metadata for one JobSpec.

Syntax:

neksus-jobspec spec status PATH [--json]

Notes: - Includes campaign metadata and advisory quality warnings.

spec lint

Purpose: Run advisory quality lint checks for one JobSpec.

Syntax:

neksus-jobspec spec lint PATH [--json]

Behavior: - Exit code 0 for valid schema, even if warnings exist. - Schema/parse errors still return non-zero exit codes.

spec preview

Purpose: Render a local preview and serve it over a local HTTP URL.

Syntax:

neksus-jobspec spec preview PATH [--theme THEME] [--port PORT] [--no-open]

Notes: - Uses only local rendering + local stdlib HTTP server. - Press Ctrl+C to stop the preview server.

spec export

Purpose: Export one JobSpec into deterministic machine-readable formats.

Syntax:

neksus-jobspec spec export PATH --target TARGET --out PATH [--json]

Targets:

  • generic-json
  • generic-xml
  • linkedin-ready-json

spec templates

Purpose: List built-in templates.

Syntax:

neksus-jobspec spec templates [--json]

Options:

  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec spec templates
neksus-jobspec spec templates --json

spec schema

Purpose: Export JobSpec JSON Schema.

Syntax:

neksus-jobspec spec schema [--output PATH] [--json]

Options:

  • --output: Write schema to file.
  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec spec schema
neksus-jobspec spec schema --output schemas/jobspec.v1.json
neksus-jobspec spec schema --json

spec inspect

Purpose: Inspect normalized JobSpec metadata.

Syntax:

neksus-jobspec spec inspect PATH [--json]

Options:

  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec spec inspect jobspecs/backend-engineer.jobspec.yaml
neksus-jobspec spec inspect jobspecs/backend-engineer.jobspec.yaml --json

spec migrate

Purpose: Inspect schema-version migration status.

Syntax:

neksus-jobspec spec migrate PATH [--write] [--json]

Options:

  • --write: Reserved, currently not implemented.
  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec spec migrate jobspecs/backend-engineer.jobspec.yaml
neksus-jobspec spec migrate jobspecs/backend-engineer.jobspec.yaml --json

render

Purpose: Batch render all *.jobspec.yaml in configured project spec_directory.

Syntax:

neksus-jobspec render [--all] [--format FORMAT] [--theme THEME] [--asset-base-url URL_OR_PATH] [--profile NAME] [--clean] [--json]

Options:

  • --all: Alias/no-op for clarity.
  • --format: web, json-ld.
  • --theme: Built-in render theme.
  • --asset-base-url: Prefix relative component asset URLs in rendered web output (web only).
  • --profile: Render profile name from config.
  • --clean: Remove output directory before render.
  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec render --format web
neksus-jobspec render --format web --theme soft-professional --clean
neksus-jobspec render --profile website --json

feed export

Purpose: Export multiple JobSpecs into jobs feed formats.

Syntax:

neksus-jobspec feed export INPUTS... --target jobs-json|jobs-xml --out PATH [--skip-invalid] [--json]

feed sitemap

Purpose: Generate sitemap XML from multiple JobSpecs.

Syntax:

neksus-jobspec feed sitemap INPUTS... --base-url URL --out PATH [--exclude-closed] [--json]

check

Purpose: Run project-level checks.

Syntax:

neksus-jobspec check [--strict] [--format human|github] [--json]

Options:

  • --strict: Treat warnings as failures.
  • --format: Output format (human or github).
  • --json: Emit machine-readable JSON.

Examples:

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

doctor

Purpose: Run local environment and repository health checks.

Syntax:

neksus-jobspec doctor [--json]

JSON notes: --json and --format github are mutually exclusive.

themes / themes list

Purpose: List available themes.

Syntax:

neksus-jobspec themes [--json]
neksus-jobspec themes list [--json]

Options:

  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec themes
neksus-jobspec themes --json

themes show

Purpose: Show metadata for one built-in theme.

Syntax:

neksus-jobspec themes show NAME_OR_PATH [--json]

Options:

  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec themes show soft-professional
neksus-jobspec themes show soft-professional --json
neksus-jobspec themes show classic
neksus-jobspec themes show classic-dark
neksus-jobspec themes show custom
neksus-jobspec themes show examples/themes/minimal

themes validate

Purpose: Validate a filesystem custom theme package.

Syntax:

neksus-jobspec themes validate PATH [--json]

themes init

Purpose: Create a minimal custom theme package scaffold.

Syntax:

neksus-jobspec themes init TARGET [--force] [--json]

config get and config set

Purpose: Read and update project config values.

Syntax:

neksus-jobspec config get [KEY] [--json]
neksus-jobspec config set KEY VALUE [--json]

Options:

  • --json: Emit machine-readable JSON.

Examples:

neksus-jobspec config get
neksus-jobspec config get default_format
neksus-jobspec config set strict_validation true