Skip to content

command-reference.md

Latest commit

 

History

History
167 lines (137 loc) · 3.69 KB

command-reference.md

File metadata and controls

167 lines (137 loc) · 3.69 KB
Raw

Command Reference

This page summarises the current public CLI surface. Check syncignore --help and the command modules under src/syncignore/commands/ for implementation truth.

Global Options

syncignore --version
syncignore --explain
syncignore --help
syncignore --verbose
syncignore --quiet
syncignore --json
syncignore --dry-run
syncignore --no-color
syncignore --config-file PATH

Global --json is used by most command groups. Telemetry is the main exception: telemetry status and telemetry metrics expose their own --json option.

Top-Level Groups

syncignore init
syncignore process
syncignore project
syncignore config
syncignore service
syncignore telemetry
syncignore template

Top-Level Aliases

syncignore list
syncignore info PROJECT
syncignore status [PROJECT]
syncignore health
syncignore validate [PROJECT]

Init

syncignore init [PROJECT_PATH]
syncignore init . --detect
syncignore init . --project-type python
syncignore init . --template nodejs
syncignore init --list-templates
syncignore init --template-info python
syncignore init wizard
syncignore init templates

Common options:

  • --project-type, -t
  • --detect, -d
  • --template
  • --list-templates
  • --template-info
  • --force, -f
  • --interactive, -i
  • --scratch-dir, -s

Process

syncignore process [PROJECT_PATH]
syncignore process . --dry-run
syncignore process . --reverse
syncignore process --all
syncignore process validate [PROJECT]
syncignore process validate [PROJECT] --fix
syncignore process status [PROJECT]

Common options:

  • --all, -a
  • --reverse, -r
  • --dry-run, -n
  • --yes, -y
  • --batch, -b
  • --force, -f

Project

syncignore project list
syncignore project list --grouped
syncignore project info PROJECT
syncignore project detect [PATH]
syncignore project health
syncignore project add PATH
syncignore project remove NAME
syncignore project rename OLD_NAME NEW_NAME

Config

syncignore config show
syncignore config show --global
syncignore config show --project
syncignore config get KEY
syncignore config set KEY=VALUE
syncignore config set KEY=VALUE --global
syncignore config validate
syncignore config reset --project --force
syncignore config edit --global

Configuration keys are validated against the current Pydantic config model.

Service

syncignore service status
syncignore service install
syncignore service install --auto-start
syncignore service uninstall
syncignore service start
syncignore service stop
syncignore service restart
syncignore service health
syncignore service config

Service availability depends on the current platform and privileges.

Telemetry

Telemetry is opt-in.

syncignore telemetry status
syncignore telemetry status --json
syncignore telemetry configure --enable --opt-in --level minimal
syncignore telemetry configure --disable
syncignore telemetry metrics --days 7
syncignore telemetry metrics --json
syncignore telemetry export --output telemetry-export.json
syncignore telemetry transmit

Template

syncignore template list
syncignore template list --format json
syncignore template list --source builtin
syncignore template search QUERY
syncignore template info NAME
syncignore template create NAME
syncignore template create NAME --project
syncignore template edit NAME
syncignore template delete NAME
syncignore template validate NAME
syncignore template test NAME PATH
syncignore template export NAME --output-file template.toml
syncignore template import template.toml
syncignore template import template.toml --scope project

Template commands support table, text, JSON, YAML, or TOML output depending on the subcommand.