Skip to main content
Auto-Skill can be installed as both an SDK library (for programmatic use) and a CLI tool (for command-line workflows).

​
Requirements

Node.js 18 or higher is required to run Auto-Skill.
Check your Node.js version: 
node --version
If you need to upgrade, visit nodejs.org or use a version manager like nvm.

​
Install as SDK

Install Auto-Skill as a dependency in your project: 
npm install @matrixy/auto-skill
Then import the SDK in your TypeScript or JavaScript code: 
import {
  createExternalSkillLoader,
  createProactiveDiscovery,
  createSkillRecommendationEngine,
} from '@matrixy/auto-skill';

​
Install as CLI

For command-line workflows, install Auto-Skill globally: 
npm install -g @matrixy/auto-skill
Verify the installation: 
auto-skill version

​
Install as Agent Skill

For AI coding agents that support the Skills CLI, install Auto-Skill as a plugin skill: 
npx skills add MaTriXy/auto-skill
This method installs Auto-Skill directly into your agent’s skills directory, enabling automatic workflow observation and pattern detection.
This is the recommended installation method for Claude Code, Cursor, Codex, Aider, and Windsurf users. The skill automatically hooks into your agent’s tool execution flow.

​
Initialize Configuration

After installation, initialize Auto-Skill’s configuration and directories: 
auto-skill init
This creates:
  • Configuration file at ~/.claude/auto-skill/config.yaml
  • Event database at ~/.claude/auto-skill/events.db
  • Skills output directory at ~/.claude/skills/auto/
  • Lock file at ~/.claude/auto-skill-lock.json

​
Optional: GitHub Token

For higher rate limits when searching community skills on Skills.sh (powered by GitHub), set a GitHub token: 
export GITHUB_TOKEN=ghp_your_token_here
Auto-Skill works without a token, but you may encounter rate limiting with heavy usage.
Create a GitHub personal access token with public_repo scope at github.com/settings/tokens.

​
Verify Installation

Check that Auto-Skill is working correctly:
1

Check CLI availability

auto-skill --help
You should see a list of available commands.
2

View configuration

auto-skill lock status
This displays the lock file status and skill integrity information.
3

Test SDK import

Create a test file:
test.ts
import { createExternalSkillLoader } from '@matrixy/auto-skill';

const loader = createExternalSkillLoader();
console.log('Auto-Skill SDK loaded successfully!');
Run it:
npx tsx test.ts

​
Supported Package Managers

Auto-Skill works with all major Node.js package managers:
Package ManagerInstall CommandGlobal Install
npmnpm install @matrixy/auto-skillnpm install -g @matrixy/auto-skill
yarnyarn add @matrixy/auto-skillyarn global add @matrixy/auto-skill
pnpmpnpm add @matrixy/auto-skillpnpm add -g @matrixy/auto-skill
bunbun add @matrixy/auto-skillbun add -g @matrixy/auto-skill

​
Dependencies

Auto-Skill has minimal dependencies:
  • better-sqlite3: Local database for event storage
  • commander: CLI framework
  • hono: Web server framework
  • yaml: Configuration file parsing
Optional dependencies:
  • sqlite-vec: Vector search capabilities (automatically used if available)

​
Disable Telemetry

Auto-Skill collects anonymous usage metrics by default. To disable telemetry: 
export AUTO_SKILL_NO_TELEMETRY=1
# or
export DO_NOT_TRACK=1
Telemetry is automatically disabled in CI environments.
Telemetry helps improve Auto-Skill but is opt-out. No PII, search queries, file paths, or session data is collected. See source code for details.

​
Next Steps

Quick Start

Build your first Auto-Skill integration

Core Concepts

Understand the architecture

Build docs developers (and LLMs) love

Get started for freeTalk to us