Skip to content

Быстрый старт

За несколько минут — от установки до первого применения инвентаря.

Что понадобится

  • Git (установлен и настроен)
  • Хотя бы одна поддерживаемая AI-среда: Claude Code, Cursor или Codex CLI

1. Установите aiman

Следуйте инструкции для вашей ОС: Установка.

Убедитесь, что установка прошла успешно:

bash
aiman --version
aiman doctor

doctor покажет обнаруженные AI-среды и всё, что требует внимания. Если что-то не так — см. Устранение проблем.

2. Подготовьте репозиторий инвентаря

Inventory — это обычный Git-репозиторий, где хранятся ваши навыки и MCP-серверы. AIM читает его и применяет содержимое в ваши AI-среды.

Нет репозитория? Создайте пустой репозиторий на GitHub или другом Git-хостинге и скопируйте URL — он понадобится на следующем шаге. Структуру внутри создаст AIM автоматически.

Есть репозиторий с навыками? aiman init создаст aim.yaml и подключит репозиторий автоматически. Важно, чтобы навыки в папке skills/ были оформлены как валидные Skill Item с корректным frontmatter — иначе aiman apply и aiman sync пропустят их. Подробнее: структура репозитория.

3. Подключите репозиторий

bash
aiman init git@github.com:you/aim-loadout.git

Здесь git@github.com:... — SSH-адрес. SSH требует настроенного ключа и обязателен для приватных репозиториев. Для публичного репозитория можно использовать HTTPS-адрес: https://github.com/you/aim-loadout.git.

Если не передать флаг --path, команда предложит локальный путь для клонирования — по умолчанию это директория с именем репозитория в текущей папке. Нажмите Enter, чтобы принять предложенный путь, или введите другой. Чтобы задать путь заранее: aiman init git@github.com:you/aim-loadout.git --path ~/projects/aim-loadout.

Если репозиторий пустой, AIM создаст базовую структуру:

text
skills/
mcp/
aim.yaml
.gitignore

Если репозиторий уже был инициализирован AIM, он будет подключён повторно и предложит запустить aiman sync.

4. Синхронизируйте инвентарь

bash
aiman sync

AIM получит опубликованное состояние из Git и применит навыки и MCP-серверы в ваши AI-среды. Если MCP-серверу нужны API-ключи или другие секреты, AIM запросит их интерактивно — значения сохранятся локально и не попадут в Git.

5. Создайте или измените навык

Откройте навык в редакторе:

bash
$EDITOR skills/my-skill.md

Минимальный формат файла навыка:

md
---
name: my-skill
description: Короткое описание навыка
targets:
  - claude-code
---

Текст промпта навыка — объяснение роли, задачи или инструкций для AI-агента.

name должно совпадать с именем файла без .md. Поле targets опционально — без него навык применяется во все обнаруженные AI-среды. Полный формат: Формат инвентаря.

Примените изменения локально без публикации:

bash
aiman apply

Проверьте навык в AI-среде. Чтобы изменения подхватились, может потребоваться перезапустить сессию агента — большинство AI-сред читают навыки при старте. Повторяйте цикл edit → apply → перезапуск до готовности.

6. Опубликуйте

bash
aiman status   # покажет неопубликованные изменения
aiman push     # валидирует, делает commit и отправляет в удалённый репозиторий

7. Синхронизируйте другую машину

На новой машине установите aiman, затем:

bash
aiman init git@github.com:you/aim-loadout.git
aiman sync

Опубликованные навыки и MCP-серверы будут применены сразу после sync.


Дальше

Released under the Apache 2.0 License.