Skip to main content

skaff project

Add a subtemplate to the current project and generate a diff (use --project PATH to override auto-discovery)

skaff project add-subtemplate PARENTINSTANCEID ROOTTEMPLATENAME TEMPLATENAME​

Add a subtemplate to the current project and generate a diff (use --project PATH to override auto-discovery)

USAGE
  $ skaff project add-subtemplate PARENTINSTANCEID ROOTTEMPLATENAME TEMPLATENAME [-f json|ndjson|tsv|table] [-h] [--project
    path] [-a] [-s <value>]

FLAGS
  -a, --apply
  -f, --format=<option>   [default: table] output format
                          <options: json|ndjson|tsv|table>
  -h, --help              Show CLI help.
  -s, --settings=<value>
      --project=path      Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Add a subtemplate to the current project and generate a diff (use --project PATH to override auto-discovery)

See code: src/commands/project/add-subtemplate.ts

skaff project clone NEWPROJECTNAME OLDPROJECTPATH​

Generate a new project from an existing one

USAGE
  $ skaff project clone NEWPROJECTNAME OLDPROJECTPATH [-f json|ndjson|tsv|table] [-h] [--project path]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Generate a new project from an existing one

See code: src/commands/project/clone.ts

skaff project delete PROJECTPATH​

Delete a project (removes its git repo)

USAGE
  $ skaff project delete PROJECTPATH [-f json|ndjson|tsv|table] [-h] [--project path]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Delete a project (removes its git repo)

See code: src/commands/project/delete.ts

skaff project diff apply DIFFHASH​

Apply a previously prepared diff by its hash (use --project PATH to override auto-discovery)

USAGE
  $ skaff project diff apply DIFFHASH [-f json|ndjson|tsv|table] [-h] [--project path]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Apply a previously prepared diff by its hash (use --project PATH to override auto-discovery)

See code: src/commands/project/diff/apply.ts

skaff project diff diff-from-template​

Generate a diff from the current project to a clean template (use --project PATH to override auto-discovery)

USAGE
  $ skaff project diff diff-from-template [-f json|ndjson|tsv|table] [-h] [--project path] [--json] [--tool <value>]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --json             Output raw JSON
      --project=path     Path to a project directory to operate on (overrides auto-discovery)
      --tool=<value>     Diff viewer (less, bat, delta, diff-so-fancy, git-split-diffs)

DESCRIPTION
  Generate a diff from the current project to a clean template (use --project PATH to override auto-discovery)

See code: src/commands/project/diff/diff-from-template.ts

skaff project diff prepare-instantiation PARENTINSTANCEID ROOTTEMPLATENAME TEMPLATENAME​

Prepare a diff for adding a sub-template instance (use --project PATH to override auto-discovery)

USAGE
  $ skaff project diff prepare-instantiation PARENTINSTANCEID ROOTTEMPLATENAME TEMPLATENAME [-f json|ndjson|tsv|table] [-h] [--project
    path] [-a] [-s <value>]

FLAGS
  -a, --apply
  -f, --format=<option>   [default: table] output format
                          <options: json|ndjson|tsv|table>
  -h, --help              Show CLI help.
  -s, --settings=<value>
      --project=path      Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Prepare a diff for adding a sub-template instance (use --project PATH to override auto-discovery)

See code: src/commands/project/diff/prepare-instantiation.ts

skaff project diff prepare-modification TEMPLATEINSTANCEID​

Prepare a diff for modifying an existing template instance (use --project PATH to override auto-discovery)

USAGE
  $ skaff project diff prepare-modification TEMPLATEINSTANCEID [-f json|ndjson|tsv|table] [-h] [--project path] [-a] [-s
  <value>]

FLAGS
  -a, --apply
  -f, --format=<option>   [default: table] output format
                          <options: json|ndjson|tsv|table>
  -h, --help              Show CLI help.
  -s, --settings=<value>
      --project=path      Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Prepare a diff for modifying an existing template instance (use --project PATH to override auto-discovery)

See code: src/commands/project/diff/prepare-modification.ts

skaff project diff prepare-update NEWREVISIONHASH​

Prepare a project-wide template update diff (use --project PATH to override auto-discovery)

USAGE
  $ skaff project diff prepare-update NEWREVISIONHASH [-f json|ndjson|tsv|table] [-h] [--project path] [-a]

FLAGS
  -a, --apply
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Prepare a project-wide template update diff (use --project PATH to override auto-discovery)

See code: src/commands/project/diff/prepare-update.ts

skaff project from-settings NEWPROJECTNAME SETTINGSFILEORJSON​

Generate a project entirely from a ProjectSettings JSON

USAGE
  $ skaff project from-settings NEWPROJECTNAME SETTINGSFILEORJSON [-f json|ndjson|tsv|table] [-h] [--project path]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Generate a project entirely from a ProjectSettings JSON

See code: src/commands/project/from-settings.ts

skaff project ls​

List projects in the current directory (use --project PATH to scope the search, --name to filter by project name)

USAGE
  $ skaff project ls [-f json|ndjson|tsv|table] [-h] [--project path] [-n <value>]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
  -n, --name=<value>     Filter by project name
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  List projects in the current directory (use --project PATH to scope the search, --name to filter by project name)

See code: src/commands/project/ls.ts

skaff project modify TEMPLATEINSTANCEID​

Modify a template instance and generate a diff (use --project PATH to override auto-discovery)

USAGE
  $ skaff project modify TEMPLATEINSTANCEID [-f json|ndjson|tsv|table] [-h] [--project path] [-a] [-s <value>]

FLAGS
  -a, --apply
  -f, --format=<option>   [default: table] output format
                          <options: json|ndjson|tsv|table>
  -h, --help              Show CLI help.
  -s, --settings=<value>
      --project=path      Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Modify a template instance and generate a diff (use --project PATH to override auto-discovery)

See code: src/commands/project/modify.ts

skaff project new PROJECTNAME TEMPLATENAME​

Create a new project from a template

USAGE
  $ skaff project new PROJECTNAME TEMPLATENAME [-f json|ndjson|tsv|table] [-h] [--project path] [-s <value>]
    [--repo <value>] [--branch <value>]

FLAGS
  -f, --format=<option>   [default: table] output format
                          <options: json|ndjson|tsv|table>
  -h, --help              Show CLI help.
  -s, --settings=<value>  Inline JSON or path to JSON file with template settings. If omitted, settings are prompted.
      --branch=<value>    [default: main] Branch to checkout when loading repo
      --project=path      Path to a project directory to operate on (overrides auto-discovery)
      --repo=<value>      Git repository URL or path to load before instantiation

DESCRIPTION
  Create a new project from a template

See code: src/commands/project/new.ts

skaff project run​

Execute a template command inside a project (use --project PATH to override auto-discovery)

USAGE
  $ skaff project run -c <value> -i <value> [-f json|ndjson|tsv|table] [-h] [--project path]

FLAGS
  -c, --command=<value>   (required) Command title as defined by the template
  -f, --format=<option>   [default: table] output format
                          <options: json|ndjson|tsv|table>
  -h, --help              Show CLI help.
  -i, --instance=<value>  (required) Template instance id (use 'root' for the root template)
      --project=path      Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Execute a template command inside a project (use --project PATH to override auto-discovery)

See code: src/commands/project/run.ts

skaff project show​

Display details for the current project (use --project PATH to override auto-discovery)

USAGE
  $ skaff project show [-f json|ndjson|tsv|table] [-h] [--project path]

FLAGS
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Display details for the current project (use --project PATH to override auto-discovery)

See code: src/commands/project/show.ts

skaff project update REVISION​

Update current project to a new template revision and generate a diff (use --project PATH to override auto-discovery)

USAGE
  $ skaff project update REVISION [-f json|ndjson|tsv|table] [-h] [--project path] [-a]

ARGUMENTS
  REVISION  Branch name or commit hash to update to

FLAGS
  -a, --apply
  -f, --format=<option>  [default: table] output format
                         <options: json|ndjson|tsv|table>
  -h, --help             Show CLI help.
      --project=path     Path to a project directory to operate on (overrides auto-discovery)

DESCRIPTION
  Update current project to a new template revision and generate a diff (use --project PATH to override auto-discovery)

See code: src/commands/project/update.ts