Skip to content

USAGE.md

Latest commit

 

History

History
187 lines (141 loc) · 3.32 KB

USAGE.md

File metadata and controls

187 lines (141 loc) · 3.32 KB

Usage Reference

This document covers the command-line usage patterns for start-it-cli, including interactive, partially guided, and non-interactive generation.

Basic Usage

Run the CLI in fully guided mode:

start-it-cli

Or provide the project name up front:

start-it-cli my-app

Output Directory

Use --path, --dir, or --directory to choose the base directory where the project folder will be created:

start-it-cli my-app --path ~/projects

This creates:

~/projects/my-app

Core Flags

--name, --project-name <name>
--path, --dir, --directory <path>
--app-type <backend|frontend|ai-ml|dsa-specific>
--stack <stack>
--profile <exam|startup|production>
--domain <label>
--app-name <name>
--yes, --non-interactive
--help

Interactive vs Non-Interactive

Fully Interactive

start-it-cli

The CLI asks for everything.

Partially Guided

start-it-cli fire_extinguisher_ms --app-type backend --stack python-fastapi

The provided values are used directly, and the remaining values are prompted for.

Non-Interactive Defaults

start-it-cli fire_extinguisher_ms --app-type backend --stack python-fastapi --yes

Any missing values are filled from defaults instead of prompting.

Stack Selection

If you provide --stack without --app-type, the CLI infers the app type automatically when possible.

Example:

start-it-cli ui-console --stack react-vite --yes

Backend Flags

--databases <csv>
--security-preset <none|bcrypt|argon2|bcrypt-jwt|argon2-jwt>
--logging <value>
--monitoring <none|health-only|prometheus-ready>
--testing <value>

Example:

start-it-cli fire_extinguisher_ms \
  --app-type backend \
  --stack python-fastapi \
  --path ~/services \
  --profile production \
  --databases postgresql,redis \
  --security-preset bcrypt-jwt \
  --logging structlog \
  --monitoring prometheus-ready \
  --testing pytest-httpx

Frontend Flags

--routing <none|react-router>
--next-router <app-router|pages-router>
--styling <plain-css|tailwind>
--ui-addon <none|shadcn-ui>
--state-management <none|context|zustand>
--data-fetching <fetch|tanstack-query>
--testing <value>

Example:

start-it-cli ops-console \
  --stack react-vite \
  --profile startup \
  --styling tailwind \
  --ui-addon shadcn-ui \
  --state-management zustand \
  --data-fetching tanstack-query \
  --testing vitest-rtl \
  --yes

AI / ML Flags

--serving-mode <value>
--execution-mode <value>
--runtime-mode <value>
--model-packaging <value>
--tracking <value>
--validation <value>
--logging <value>
--testing <value>

Example:

start-it-cli model-serving \
  --stack python-fastapi-serving \
  --profile production \
  --serving-mode realtime-plus-batch \
  --model-packaging mlflow-ready \
  --tracking mlflow \
  --validation pydantic-plus-pandera \
  --logging structlog \
  --testing pytest-httpx \
  --yes

DSA Flags

--track <competitive-programming|interview-prep>
--input-mode <stdin-stdout|function-first>
--testing <manual-cases|ctest|pytest>

Example:

start-it-cli algo-lab \
  --stack dsa-python \
  --track interview-prep \
  --input-mode function-first \
  --testing pytest \
  --yes

Help

Print the command reference:

start-it-cli --help