Files
skillshare/website/docs/reference/commands/doctor.md
T
Willie 69d643525d fix(targets): point the codex target at ~/.agents/skills
Codex documents ~/.agents/skills as its user-level skills path and marks
~/.codex/skills as deprecated, while still reading both. It does not merge
skills that share a name, so the default init result (codex + universal)
showed every skill twice in Codex.

The codex target now defaults to the shared directory, keeps the old path
in also_scans, and is detected through ~/.codex. A fresh init therefore sets
up only `universal` for Codex and writes each skill once. Existing configs
keep their pinned path and still get the doctor overlap warning that
suggests removing the codex target.

Refs #135
2026-09-21 02:21:49 +08:00

9.7 KiB
Raw Blame History

sidebar_position
sidebar_position
1

doctor

Check environment and diagnose issues with your skillshare setup.

skillshare doctor
skillshare doctor -p        # Project mode (.skillshare/config.yaml)
skillshare doctor -g        # Force global mode
skillshare doctor --json    # Structured JSON output for CI

doctor demo

When to Use

  • Something isn't working and you don't know why
  • After upgrading skillshare or your OS
  • Verify all targets, git, and symlinks are healthy
  • First diagnostic step before filing a bug report

What It Checks

skillshare doctor

Checking environment
✓ Config: ~/.config/skillshare/config.yaml
→ Config directory: ~/.config/skillshare
→ Data directory:   ~/.local/share/skillshare
→ State directory:  ~/.local/state/skillshare

✓ Source: ~/.config/skillshare/skills (12 skills)
✓ Agents source: ~/.config/skillshare/agents (8 agents)
✓ Skillignore: 2 patterns, 1 skills ignored
✓ Link support: OK
✓ Git: initialized with remote

✓ Skill integrity: 12/12 verified

Checking targets
claude
  skills   [merge] merged (8 shared, 2 local)
  agents   [merge] merged (8/8 linked)
cursor
  skills   [copy] copied (8 managed, 0 local)
  agents   [merge] merged (8/8 linked)
codex
  skills   [merge] needs sync

Extras
✓ rules: 4 files, 1/1 targets OK
✓ commands: 3 files, 1/1 targets OK

Version
✓ CLI: 0.17.0
✓ Skill: 0.17.0

Summary
✓ All checks passed!

Checks Performed

Environment

Check What It Verifies
Config Config file exists and is valid
Source Source directory exists and is readable
Agents source Agents source directory exists (if configured)
Skillignore .skillignore (and .skillignore.local) active patterns and ignored skill count
Link support System can create symlinks
Git Repository status and remote configuration

Targets

Each target shows sub-items for skills and agents (when agents are configured):

  • Skills: path, sync mode, sync state, shared/local counts
  • Agents: linked count, drift detection
  • No broken symlinks
  • Duplicate-skill checks for unintended local collisions:
    • merge mode: skipped (local skills are expected)
    • copy mode: manifest-managed copies are ignored; only local colliding copies are warned
  • Valid include/exclude glob patterns
  • Info-level per-target compatibility hint when applicable (example target priority: cursor → antigravity → copilot → opencode; no hint when these targets are absent)

Path Overlap

Doctor flags two classes of duplicate-skill risk before they reach the runtime picker:

shared_target_paths — fires when two or more enabled targets resolve to the same primary path. Common cause: enabling both universal and a tool that writes to ~/.agents/skills (e.g. warp, witsy).

! Shared path ~/.agents/skills ← universal, warp

Resolution: disable one of the overlapping targets, or set a distinct path with skillshare target <name> --path <dir>.

cross_target_discovery — fires when an enabled target's runtime is documented to also scan a directory another enabled target writes to. For example, a config left over from an older setup still points codex at the legacy ~/.codex/skills, while universal writes to ~/.agents/skills — which Codex also reads. Enabling both makes Codex see universal's content on top of its own.

! codex will see content from: universal
    ~/.agents/skills ← universal

Resolution: start by removing the scanning target (codex above). Its runtime already reads the shared directory, and no other tool is affected. Preview with skillshare target remove codex --dry-run. Removing the writer (universal) instead also hides those skills from every other tool that reads ~/.agents/skills. Keep both targets only if the scanning target carries skills the writer filters out, and accept the duplicate listings in the runtime picker.

Both checks are pure metadata — they read configured paths and the built-in also_scans table, no filesystem probing.

Version

  • CLI version
  • skillshare skill version
  • Checks for available updates

Skill Integrity

For installed skills with file hash metadata, doctor verifies that no files have been tampered with since installation:

  • Compares current SHA-256 hashes against stored hashes
  • Reports modified, missing, and added files per skill
  • Local skills (not in .metadata.json) are silently skipped — this is expected
  • Installed skills with metadata but missing file_hashes are flagged with their names
⚠ _team-repo__api-helper: 1 modified, 1 missing
✓ Skill integrity: 5/6 verified
⚠ Skill integrity: 1 skill(s) missing file hashes: _old-repo__legacy-skill

Extras

When extras are configured, verifies:

  • Source directory exists for each extra
  • Target directories are reachable
  • Reports missing source directories or unreachable targets

Other

  • Skills without SKILL.md files
  • Skill-level targets: field validation (warns on unknown target names)
  • Last backup timestamp (global mode)
  • Trash status (item count, total size, oldest item age)
  • Broken symlinks in targets

:::note Project Mode When a project has .skillshare/config.yaml, skillshare doctor auto-runs in project mode.

In project mode:

  • Config/source checks use .skillshare/config.yaml and .skillshare/skills
  • Trash status uses .skillshare/trash
  • Backups show not used in project mode :::

Common Issues

"Needs sync"

Target mode was changed but not applied:

skillshare sync

"Not synced"

Target has fewer linked skills than source (e.g. after installing new skills):

skillshare sync

"Has uncommitted changes"

Tracked repo has local changes:

cd ~/.config/skillshare/skills/_team-repo
git status
# Commit or discard changes

A skill was removed from source but symlink remains:

skillshare sync  # Will prune orphaned symlinks

"Skills without SKILL.md"

Skill folders missing required file:

# Add SKILL.md to each skill, or remove the folder
skillshare new my-skill  # Creates proper structure

On Windows without Developer Mode:

  1. Enable Developer Mode in Settings
  2. Or run as Administrator

Example Output with Issues

Checking environment
✓ Config: ~/.config/skillshare/config.yaml
✓ Source: ~/.config/skillshare/skills (12 skills)
✓ Agents source: ~/.config/skillshare/agents (8 agents)
✓ Link support: OK
⚠ Git: 3 uncommitted change(s)

⚠ Skills without SKILL.md: test-dir, temp
⚠ _team-repo__api-helper: 1 modified
✓ Skill integrity: 5/6 verified

Checking targets
claude
  skills   [merge] merged (8 shared, 2 local)
  agents   [merge] merged (8/8 linked)
cursor
  skills   [merge] 2 broken symlink(s): old-skill, removed-skill
codex
  skills   [merge] needs sync
⚠ claude: 1 skill(s) not synced (2/3 linked)

Version
✓ CLI: 0.17.0
⚠ Skill: 0.16.0 (update available: 0.17.0)
  Run: skillshare upgrade --skill && skillshare sync

Backups: last backup 2026-01-18_09-00-00 (3 days ago)
ℹ Trash: 2 item(s) (45.2 KB), oldest 3 day(s)

ℹ Update available: 1.2.0 -> 1.3.0
  brew upgrade skillshare  OR  curl -fsSL .../install.sh | sh

Summary
  ✗ 1 error(s), 4 warning(s)

JSON Output

Use --json for machine-readable output in CI pipelines and automation:

skillshare doctor --json
{
  "checks": [
    { "name": "source", "status": "pass", "message": "Source: ~/.config/skillshare/skills (12 skills)" },
    { "name": "skillignore", "status": "pass", "message": ".skillignore: 3 patterns, 2 skills ignored", "details": ["test-*", "vendor/", "!important", "---", "test-draft", "vendor/lib"] },
    { "name": "sync_drift", "status": "warning", "message": "claude: 1 skill(s) not synced (7/8 linked)", "details": ["new-skill"] },
    { "name": "shared_target_paths", "status": "warning", "message": "1 shared target path(s) — enabled targets writing to the same directory may produce duplicate skills in runtime pickers", "details": ["~/.agents/skills ← universal, warp"], "suggestions": ["Choose one authoritative target for ~/.agents/skills and disable or reconfigure the rest (currently: universal, warp)"] },
    { "name": "broken_symlinks", "status": "error", "message": "cursor: 1 broken symlink(s)", "details": ["old-skill"] }
  ],
  "summary": { "total": 14, "pass": 12, "warnings": 1, "errors": 1, "info": 0 },
  "version": { "current": "0.17.4", "latest": "0.18.0", "update_available": true }
}

Check statuses: pass, warning, error, info. The info status is used for informational checks (e.g., .skillignore not found) that are neither passing nor failing. Info checks count toward total but not toward pass, warnings, or errors.

Some warning checks (e.g. shared_target_paths, cross_target_discovery) also include an optional suggestions array with actionable remediation steps. The field is omitted when there is nothing to suggest.

Exit Codes

Condition Exit Code
All checks pass (or warnings only) 0
Any check has error status 1

CI Example

# Fail pipeline if doctor finds errors
skillshare doctor --json | jq -e '.summary.errors == 0'

# Extract warnings for notification
skillshare doctor --json | jq '[.checks[] | select(.status == "warning")]'

:::tip Web Dashboard The Health Check page in the web dashboard (skillshare ui) provides a visual version of doctor --json with filter toggles and expandable details. :::

See Also

  • status — Quick status check
  • sync — Fix sync issues
  • upgrade — Update CLI and skill