Справочник OpenSkills CLI API
Чему вы научитесь
- Полное использование всех команд OpenSkills
- Параметры и опции каждой команды
- Комбинирование команд для выполнения задач
Что это такое
Справочник OpenSkills CLI API предоставляет полную документацию по всем командам, включая параметры, опции и примеры использования. Это справочное руководство, которое вы используете, когда вам нужно подробно изучить конкретную команду.
Обзор
OpenSkills CLI предоставляет следующие команды:
openskills install <source> # Установить навык
openskills list # Список установленных навыков
openskills read <name> # Читать содержимое навыка
openskills sync # Синхронизировать с AGENTS.md
openskills update [name...] # Обновить навыки
openskills manage # Интерактивное управление навыками
openskills remove <name> # Удалить навыкКоманда install
Установка навыков из GitHub, локального пути или частного git-репозитория.
Синтаксис
openskills install <source> [options]Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
<source> | string | Y | Источник навыка (см. форматы ниже) |
Опции
| Опция | Сокращение | Тип | По умолчанию | Описание |
|---|---|---|---|---|
--global | -g | flag | false | Глобальная установка в ~/.claude/skills/ |
--universal | -u | flag | false | Установка в .agent/skills/ (многоагентная среда) |
--yes | -y | flag | false | Пропустить интерактивный выбор, установить все найденные навыки |
Форматы источников
| Формат | Пример | Описание |
|---|---|---|
| Сокращение GitHub | anthropics/skills | Из публичного репозитория GitHub |
| Git URL | https://github.com/owner/repo.git | Полный Git URL |
| SSH Git URL | git@github.com:owner/repo.git | Частный репозиторий SSH |
| Локальный путь | ./my-skill или ~/dev/skills | Из локального каталога |
Примеры
# Установка из GitHub (интерактивный выбор)
openskills install anthropics/skills
# Установка из GitHub (неинтерактивная)
openskills install anthropics/skills -y
# Глобальная установка
openskills install anthropics/skills --global
# Установка в многоагентной среде
openskills install anthropics/skills --universal
# Установка из локального пути
openskills install ./my-custom-skill
# Установка из частного репозитория
openskills install git@github.com:your-org/private-skills.gitВывод
После успешной установки отображается:
- Список установленных навыков
- Место установки (project/global)
- Подсказка выполнить
openskills sync
Команда list
Список всех установленных навыков.
Синтаксис
openskills listПараметры
Нет.
Опции
Нет.
Примеры
openskills listВывод
Установленные навыки:
┌────────────────────┬────────────────────────────────────┬──────────┐
│ Имя навыка │ Описание │ Место │
├────────────────────┼────────────────────────────────────┼──────────┤
│ pdf │ PDF manipulation toolkit │ project │
│ git-workflow │ Git workflow automation │ global │
│ skill-creator │ Guide for creating effective skills │ project │
└────────────────────┴────────────────────────────────────┴──────────┘
Статистика: 3 навыка (2 проектных, 1 глобальный)Описание местоположения навыков
- project: Установлен в
.claude/skills/или.agent/skills/ - global: Установлен в
~/.claude/skills/или~/.agent/skills/
Команда read
Чтение содержимого навыка в стандартный вывод (для использования AI-агентом).
Синтаксис
openskills read <skill-names...>Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
<skill-names...> | string | Y | Имена навыков (список через запятую) |
Опции
Нет.
Примеры
# Чтение одного навыка
openskills read pdf
# Чтение нескольких навыков (через запятую)
openskills read pdf,git-workflow
# Чтение нескольких навыков (через пробел)
openskills read pdf git-workflowВывод
=== SKILL: pdf ===
Base Directory: /path/to/.claude/skills/pdf
---
# PDF Skill Instructions
When user asks you to work with PDFs, follow these steps:
1. Install dependencies: `pip install pypdf2`
2. Extract text using scripts/extract_text.py
3. Use references/api-docs.md for details
=== END SKILL ===Назначение
Эта команда в основном используется AI-агентом для загрузки содержимого навыка. Пользователи также могут использовать её для просмотра подробного описания навыка.
Команда sync
Синхронизация установленных навыков с AGENTS.md (или другим файлом).
Синтаксис
openskills sync [options]Параметры
Нет.
Опции
| Опция | Сокращение | Тип | По умолчанию | Описание |
|---|---|---|---|---|
--output <path> | -o | string | AGENTS.md | Путь к выходному файлу |
--yes | -y | flag | false | Пропустить интерактивный выбор, синхронизировать все навыки |
Примеры
# Синхронизация с AGENTS.md по умолчанию (интерактивная)
openskills sync
# Синхронизация с пользовательским путём
openskills sync -o .ruler/AGENTS.md
# Неинтерактивная синхронизация (CI/CD)
openskills sync -y
# Неинтерактивная синхронизация с пользовательским путём
openskills sync -y -o .ruler/AGENTS.mdВывод
После завершения синхронизации в указанном файле создаётся следующее содержимое:
<skills_system priority="1">
## Available Skills
<!-- SKILLS_TABLE_START -->
<usage>
When users ask you to perform tasks, check if any of the available skills below can help complete the task more effectively.
How to use skills:
- Invoke: `npx openskills read <skill-name>` (run in your shell)
- The skill content will load with detailed instructions
- Base directory provided in output for resolving bundled resources
Usage notes:
- Only use skills listed in <available_skills> below
- Do not invoke a skill that is already loaded in your context
</usage>
<available_skills>
<skill>
<name>pdf</name>
<description>Comprehensive PDF manipulation toolkit for extracting text and tables, creating new PDFs, merging/splitting documents, and handling forms.</description>
<location>project</location>
</skill>
</available_skills>
<!-- SKILLS_TABLE_END -->
</skills_system>Команда update
Обновление установленных навыков из источника.
Синтаксис
openskills update [skill-names...]Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
[skill-names...] | string | N | Имена навыков (через запятую), по умолчанию все |
Опции
Нет.
Примеры
# Обновить все установленные навыки
openskills update
# Обновить указанные навыки
openskills update pdf,git-workflow
# Обновить один навык
openskills update pdfВывод
Updating skills...
✓ Updated pdf (project)
✓ Updated git-workflow (project)
⚠ Skipped old-skill (no metadata)
Summary:
- Updated: 2
- Skipped: 1Правила обновления
- Обновляются только навыки с записанными метаданными
- Навыки из локального пути: прямое копирование из исходного пути
- Навыки из Git-репозитория: повторное клонирование и копирование
- Навыки без метаданных: пропускаются с подсказкой переустановить
Команда manage
Интерактивное управление (удаление) установленных навыков.
Синтаксис
openskills manageПараметры
Нет.
Опции
Нет.
Примеры
openskills manageИнтерактивный интерфейс
Выберите навыки для удаления:
[ ] pdf - PDF manipulation toolkit
[ ] git-workflow - Git workflow automation
[*] skill-creator - Guide for creating effective skills
Действия: [↑/↓] выбор [пробел] переключить [Enter] подтвердить [Esc] отменаВывод
Удалено 1 навык:
- skill-creator (project)Команда remove
Удаление указанных установленных навыков (скриптовый способ).
Синтаксис
openskills remove <skill-name>Псевдоним
rm
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
<skill-name> | string | Y | Имя навыка |
Опции
Нет.
Примеры
# Удалить навык
openskills remove pdf
# Использовать псевдоним
openskills rm pdfВывод
Удалён навык: pdf (project)
Место: /path/to/.claude/skills/pdf
Источник: anthropics/skillsГлобальные опции
Следующие опции применимы ко всем командам:
| Опция | Сокращение | Тип | По умолчанию | Описание |
|---|---|---|---|---|
--version | -V | flag | - | Показать версию |
--help | -h | flag | - | Показать справку |
Примеры
# Показать версию
openskills --version
# Показать глобальную справку
openskills --help
# Показать справку по конкретной команде
openskills install --helpПриоритет поиска навыков
Когда существует несколько мест установки, навыки ищутся в следующем приоритете (от высокого к низкому):
./.agent/skills/- проектный уровень universal~/.agent/skills/- глобальный уровень universal./.claude/skills/- проектный уровень~/.claude/skills/- глобальный уровень
Важно: Возвращается только первый найденный навык (с наивысшим приоритетом).
Коды выхода
| Код выхода | Описание |
|---|---|
| 0 | Успех |
| 1 | Ошибка (ошибка параметров, сбой команды и т.д.) |
Переменные окружения
Текущая версия не поддерживает конфигурацию переменных окружения.
Файлы конфигурации
OpenSkills использует следующие файлы конфигурации:
- Метаданные навыка:
.claude/skills/<skill-name>/.openskills.json- Записывает источник установки, временные метки и т.д.
- Используется командой
updateдля обновления навыков
Пример метаданных
{
"name": "pdf",
"source": "anthropics/skills",
"sourceType": "github",
"repoUrl": "https://github.com/anthropics/skills.git",
"subpath": "pdf",
"installedAt": "2024-01-15T10:30:00.000Z"
}Предпросмотр следующего урока
В следующем уроке мы изучим Формат AGENTS.md.
Вы узнаете:
- Структуру XML-тегов AGENTS.md и значение каждого тега
- Определения полей и ограничения списка навыков
- Как OpenSkills создаёт и обновляет AGENTS.md
- Способы разметки (XML-теги и HTML-комментарии)
Приложение: Ссылка на исходный код
Нажмите, чтобы раскрыть расположение исходного кода
Обновлено: 2026-01-24
| Команда | Путь к файлу | Строки |
|---|---|---|
| Вход CLI | src/cli.ts | 13-80 |
| Команда install | src/commands/install.ts | 1-562 |
| Команда list | src/commands/list.ts | 1-50 |
| Команда read | src/commands/read.ts | 1-50 |
| Команда sync | src/commands/sync.ts | 1-101 |
| Команда update | src/commands/update.ts | 1-173 |
| Команда manage | src/commands/manage.ts | 1-50 |
| Команда remove | src/commands/remove.ts | 1-30 |
| Определения типов | src/types.ts | 1-25 |
Ключевые константы:
- Нет глобальных констант
Ключевые типы:
Skill: Интерфейс информации о навыке (name, description, location, path)SkillLocation: Интерфейс местоположения навыка (path, baseDir, source)InstallOptions: Интерфейс опций установки (global, universal, yes)
Ключевые функции:
program.command(): Определение команды (commander.js)program.option(): Определение опции (commander.js)program.action(): Определение обработчика команды (commander.js)