CLI Reference

The sc command-line interface is the primary tool for interacting with Supernal Coding. All commands can be run with either sc or supernal-coding prefix.

Installation

npm install -g supernal-coding

Verify installation:

sc --version
sc --help

Command Categories

Project Setup

Command	Description
`init`	Initialize Supernal Coding in a repository
`doctor`	Check system compatibility

Requirements Management

Command	Description
`req`	Requirement lifecycle management
`kanban`	Kanban board and task management
`priority`	Priority management for requirements
`validate`	Validate requirements and structure

Git Workflow

Command	Description
`git-smart`	Smart git workflow utilities
`git-hooks`	Git hooks management

Development Tools

Command	Description
`agent`	Agent workflow management
`dev`	Development tools and utilities
`deploy`	Deploy project components
`workflow`	Workflow state tracking

Documentation

Command	Description
`docs`	Documentation management
`generate`	Generate project files
`map`	Generate command mappings

Utilities

Command	Description
`help`	Show comprehensive help
`suggest`	Create GitHub issues with context
`date-validate`	Fix hardcoded dates
`fix-frontmatter`	Fix frontmatter issues

Quick Start

# Get help for any command
sc <command> --help

# Initialize a new project
sc init --standard

# Create a requirement
sc planning req new "Feature description" --priority=high

# Start work on a requirement
sc planning req start-work REQ-001

# View kanban board
sc kanban list

# Validate project
sc validate --all

# Safe merge
sc git smart merge --push --delete-local

Global Options

All commands support these global options:

--help          Show help for command
--version       Show version number
--verbose       Enable verbose output
--quiet         Suppress non-essential output
--no-color      Disable colored output

Environment Variables

Variable	Description
`SC_CONFIG`	Custom config file path
`SC_QUIET`	Suppress output (CI mode)
`SC_NO_COLOR`	Disable colors
`SC_SKIP_HOOKS`	Skip git hooks

Configuration

Commands are configured via supernal.yaml or supernal-code.config.toml in your project root.

# supernal.yaml example
project:
  name: "My Project"
  
requirements:
  default_priority: medium
  
git_hooks:
  enabled: true

CLI Reference

agent

date-validate

deploy

dev

docs

fix-frontmatter

generate

git-hooks

git-smart

help

init-req-tracking

kanban

map

priority

suggest

validate

workflow