Files
skillshare/website/docs/reference/commands/project.md
T
Rusty Shackleford 5729eee088 feat(project): manage global registrations from the CLI (#603)
Add global project list, show, add, edit, sync and remove so setup scripts
can register repositories without editing YAML or opening the dashboard.
Keep dry runs read-only and report completed work when a target fails.

Reuse the shared project service and sync runners. Include command docs,
translations, completions and regression coverage. Quote overlap hints for
their shell and log partial project syncs consistently with ordinary sync.
2026-10-26 01:38:04 +08:00

8.2 KiB

sidebar_position
sidebar_position
21

project

Manage project folders in the global config and sync skills and agents into them, without creating a .skillshare/ configuration in each folder.

project always uses the global config, even when run inside a project. This differs from -p / --project, which selects a repo's own configuration and is rejected by this command. Use project mode when teammates should receive the setup with the repo.

Usage

skillshare project                          # Same as project list
skillshare project list --json
skillshare project show <project> --json
skillshare project add <root> --target T [options]
skillshare project edit <project> [options]
skillshare project sync <project> [--dry-run] [--json]
skillshare project remove <project> [--yes] [--dry-run] [--json]

add requires an existing folder and at least one target. Other commands accept the effective project name (custom name or folder basename) or its root path. Prefix relative paths with ./ or ../ to select a root explicitly. If a bare token matches one project's name and another project's root, the command reports both candidates instead of choosing one. Symlink aliases stay separate registrations.

Flags

Flag Applies to Description
--target T add, edit Target tools; repeat or use a comma list. Required for add; replaces the entire list on edit
--name N add, edit Custom name; --name= restores the folder basename
--skills, --no-skills add, edit Enable or disable skills; enabled by default on add
--agents, --no-agents add, edit Enable or disable agents; disabled by default on add
--skills-mode MODE, --agents-mode MODE add, edit merge, symlink, or copy; empty value clears the override
--skills-naming NAMING add, edit flat, standard, or prefixed; empty value inherits
--skills-include P, --skills-exclude P add, edit Repeat for multiple glob patterns; replaces the corresponding list; empty value clears it
--agents-include P, --agents-exclude P add, edit Same replacement semantics for agents; filters require merge or copy mode
--sync add, edit Save, then sync this project's skills and agents; force is off
--dry-run, -n add, edit, sync, remove Preview without writing or prompting
--yes remove Skip confirmation; required for removal with JSON unless previewing
--json all Structured output; check the process exit code as well
--global, -g all Explicit global scope (also the default for this command)
--help, -h all Show help

Resource settings turn on that resource, including clearing an existing enabled: false. Omitted settings preserve its disabled state. Editing changes only supplied settings; enabling an existing resource keeps its settings. Opposing toggles and disable-plus-setting combinations such as --no-skills --skills-mode copy are rejected. There is no agents naming flag. Unlike target, these include/exclude flags replace lists rather than add or remove individual patterns.

Examples

Register, preview, and sync

skillshare project add ~/work/shop-web --target claude,codex \
  --skills-mode copy --skills-include 'frontend-*' --agents --dry-run
skillshare project add ~/work/shop-web --target claude,codex \
  --skills-mode copy --skills-include 'frontend-*' --agents --sync
skillshare project show shop-web --json

The saved entry belongs to projects. Shared tool folders are grouped into one sync target. A normal skillshare sync also syncs registered projects.

Projects with skills disabled never run the skills pass, including in global symlink mode. An empty requested/enabled resource selection succeeds without discovery, backups or target writes.

Replace filters or reset overrides

skillshare project edit shop-web --skills-include 'frontend-*' --skills-include 'core-*'
skillshare project edit shop-web --skills-exclude= --skills-mode= --name=
skillshare project sync shop-web --dry-run --json
skillshare project sync shop-web --json

Add and edit validate the full effective configuration before writing. YAML anchors can affect other entries; mutation results list every affected root. A no-op add or edit returns applied: false and unchanged: true, and still honors --sync. Repeating add with different settings fails and points at project edit. Custom names must not look like roots (for example ~name, ./name, or C:name).

Remove a registration

skillshare project remove shop-web --dry-run --json
skillshare project remove shop-web --yes --json

Removal detaches skills before removing the registration. A whole-folder link is removed; merge-mode links become local copies while their source content exists; copy-mode files remain and their manifest is removed. A path still owned by a surviving enabled target is retained.

CLI edits detach dropped skill paths by the same rules. While a project's skills remain off, any CLI edit, including a rename or an agents-only edit, also detaches its remaining skill paths, even if skills were turned off earlier in the dashboard. Copy-back and surviving enabled-target ownership rules still apply. Dashboard saves never detach skills. Agent files remain in place. The preview and result list removed, copied-back, and retained paths.

JSON and failures

Command Main fields
list projects array (empty when none are registered)
show project object
add, edit, remove action, project, applied, affected, warnings; optional sync or detach
sync action, project, sync; previews also have applied: false

Project objects include root (stored spelling), path (expanded path), name, targets, skills, agents, groups, missing, and hasOwnConfig. An omitted or disabled resource is null. Enabled resources expose their settings. Text project list and project show report the on/off state. The sync result includes results, failed, warnings, and discovery/filter diagnostics.

A failed target makes sync exit 1 while reporting completed targets. Sync previews report conflicts in failed and exit 0; invalid input still fails. If add/edit saves successfully but its sync fails, the registration stays saved; fix the target and retry with project sync. A missing project folder can still be edited, but cannot be synced.

Edits and removals are not transactional: a later detach or save failure can leave earlier filesystem changes in place. The JSON result reports completed detach, registration (kept, updated, or removed), and error. A failed edit save has applied: false and describes the persisted project; a successful save followed by failed sync keeps applied: true; inspect those fields before retrying. Failures before any changes use an error payload. List, show, previews, and JSON output skip startup migrations, cleanup, and the version check; text add, edit, sync, and remove run them like other commands.

This command manages skills and agents only. MCP project settings and hooks use their own commands; it does not convert targets or edit a project's own config.

Concurrent project writers

CLI and dashboard project mutations share a gofrs/flock lock in the skillshare state directory, keyed by the resolved global config destination, wait up to 10 seconds, and reload after acquiring it. Config symlinks share the same lock. Reads and dry runs do not create or acquire it. Other config writers, including target, MCP, hooks, and ordinary Config.Save() callers, remain outside this protection; concurrent writes through those paths can still overwrite changes.