Skip to content

Installation

  • Node.js 22 or newer
  • Git available on PATH
  • Git credentials or an SSH agent that can read and write the library repository
  • Optional: the GitHub CLI (gh) when using init --create

Install skill-sync globally with npm:

Terminal window
npm install --global skill-sync
skill-sync --help

The help command should list init, install, sync, publish, status, and the other library and project commands. Run skill-sync doctor at any time to inspect the runtime, Git, authentication, configuration, cache, and project state without making repairs.

skill-sync accepts HTTPS and SSH Git remotes. Authentication stays in your normal Git credential helper, SSH agent, or GitHub CLI session; credentials must not be embedded in a remote URL.

For SSH, verify that your agent can reach GitHub:

Terminal window
ssh -T git@github.com

For GitHub repository creation over the CLI, authenticate gh first:

Terminal window
gh auth login

Plain http:// remote input is upgraded to HTTPS. Repository content is treated as inert data: fetched scripts, package lifecycle commands, hooks, filters, and submodules are not run.

Project commands normally discover the repository from your current directory. Use the global --project <path> option when you need to operate on another root explicitly:

Terminal window
skill-sync --project /path/to/project status

Next, connect or create your library in the quick start.