Skip to content
Apothem
Установка

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

Установите Apothem, составьте профиль, материализуйте первое окружение и проверьте его — обзор с готовыми к копированию командами и ожидаемым выводом.

Это быстрый путь от нуля до проверенной конфигурации окружения: установка, составление общего профиля, материализация нативной конфигурации одного инструмента, её подтверждение и первая правка. Каждая команда настоящая, её можно скопировать, вставить и запустить, и каждый шаг показывает, что выводит чистый запуск. Сама установка занимает меньше двух минут; редактирование профиля — единственная часть, которая занимает столько времени, сколько вы захотите.

К концу у вас будет рабочая конфигурация окружения, сгенерированная из написанного вами профиля, — и вы будете знать ту единственную команду, которая заново доставляет изменение профиля в один инструмент или во все сразу.

Нужна неторопливая версия с пояснениями?

Вводный туториал проходит тот же путь, подробнее объясняя каждый шаг и то, почему он важен. Эта страница — краткий обзор, в котором на первом месте стоит вывод команд.

В качестве примера окружения вы будете использовать Claude Code — это значение установщика по умолчанию. Замените имя адаптера на любом шаге, чтобы нацелиться на другой инструмент; в списке окружений есть все поддерживаемые имена.

1. Установка Apothem

Apothem поставляется как самодостаточная среда выполнения: движок запускается прямо из своего дерева исходного кода с вендоренными зависимостями. Одна команда загружает исходный код, размещает движок и материализует ваше первое окружение. Установка сначала проверяет подписанный релиз, поэтому однократно импортируйте ключ подписи сопровождающего перед первой установкой и проверьте, что отпечаток равен 5C89 98F9 F241 7204 45D3 F28B 7039 6FED 9C63 4163:

macOS · Linux · WSL2 · BSD — import the key once
curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import
gpg --fingerprint 70396FED9C634163
Windows · PowerShell — import the key once
& "$env:ProgramFiles\Git\bin\bash.exe" -c 'curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import && gpg --fingerprint 70396FED9C634163'

Затем запустите установщик:

macOS · Linux · WSL2
curl -fsSL https://apothem.ahmedgad.com/install.sh | bash
Windows · PowerShell 5.1+
irm https://apothem.ahmedgad.com/install.ps1 | iex

Установщику нужны системный Python 3.10+, а также git и gpg для сетевой формы. Он проверяет предварительные требования и размещает движок в ~/.apothem. Если click или rich отсутствует, он устанавливает пакет с вашего подтверждения, либо при --yes (-Yes в PowerShell), либо при APOTHEM_AUTO_INSTALL_DEPS=1, а в остальных случаях останавливается с командой pip, которую нужно выполнить (см. Предварительные требования кратко). По завершении он выводит баннер со следующими шагами; в POSIX, когда каталог шима уже находится в PATH, баннер выглядит так:

Installation complete.

The 'apothem' command is on your PATH.

Recommended first step — the guided setup (profile -> preview -> install):

  apothem quickstart

Первый запуск без профиля

Если у вас ещё нет профиля, установщик копирует пример профиля в ~/.config/apothem/profile.yaml и продолжает работу: он материализует ваше первое окружение и проверяет его в том же запуске. Поля идентичности в примере — заполнители, поэтому установка выводит примечание. Сделайте профиль своим на шаге 2, затем примените его командой apothem update --harness <name>, как на шаге 5.

Команда `apothem`

Установщик записывает шим apothem в $HOME/.local/bin (POSIX) или %LOCALAPPDATA%\Microsoft\WindowsApps (Windows) и никогда не изменяет ваш PATH. Как только этот каталог окажется в PATH, вы запускаете движок напрямую как apothem <command>. Если он ещё не находится в PATH, баннер выводит самодостаточный запасной вариант — PYTHONPATH="$HOME/.apothem/src" python3 -m apothem <command>, — которому не нужен шим; добавляйте перед каждой командой точный префикс, который вывел ваш баннер.

Руководство по установке описывает другие пути установки — плагин Claude Code (/plugin marketplace add ahmed-g-gad/apothem, затем /plugin install apothem@apothem); расширения для семейства VS Code и другие нативные расширения инструментов; и форму npx по требованию (npx @ahmed-g-gad/apothem <command>), — а также параметры, задаваемые переменными окружения.

2. Создание общего профиля

apothem profile init записывает минимальный профиль, проходящий проверку по схеме, в ~/.config/apothem/profile.yaml. Если профиль там уже есть, как в случае, когда установщик на шаге 1 скопировал пример, init останавливается с ошибкой и оставляет файл без изменений; передайте --force, чтобы перезаписать его, или оставьте файл и отредактируйте его, как показано ниже. Передайте --profile PATH, если вы храните профиль для конкретного проекта или CI в другом месте.

apothem profile init
apothem profile show --json

Заготовка использует фиктивные данные идентичности-заполнители, и её безопасно редактировать до того, как вы установите какой-либо вывод окружения. show --json читает её обратно и сообщает проверенный профиль со всеми заполненными значениями по умолчанию, начиная с schema_version. Команда выводит его одной строкой; здесь он развёрнут:

{
  "schema_version": 1,
  "identity": {
    "name": "Example User",
    "role": "senior software engineer",
    "email": "[email protected]",
    "github": "example-user"
  },
  "preferences": {
    "language": "python",
    "style": "concise"
  },
  "rules": [],
  "seriousness": "PERSONAL_USE",
  "enforcement": {
    "sprints": false,
    "agent_teams": false,
    "multitasking": false,
    "continuous_execution": false,
    "learning_loop": false
  },
  "mcp_servers": {},
  "agent_mcp_servers": {},
  "harnesses": {},
  "exclude_harnesses": [],
  "workspace": {
    "directory_name": ".apothem",
    "scope": "project-local"
  }
}

Здесь же проявляется и некорректная правка — если YAML невалиден, show сообщает об этом здесь, до того как будет записана какая-либо конфигурация окружения. Сделайте профиль своим с помощью apothem profile edit (открывает его в вашем редакторе) или задайте отдельный ключ на месте:

apothem profile set identity.name "Your Name"

3. Установка адаптеров окружений

Материализуйте адаптер для вашего основного окружения. Эта команда читает ваш профиль и записывает нативную конфигурацию этого инструмента:

apothem install --harness claude-code
✓ Installed claude-code -> /home/you/.claude/settings.json

Адаптеры уровня проекта пишут свой файл правил внутрь проекта, поэтому им нужен --project PATH; семь из них также записывают навыки и общие правила в папки в вашем домашнем каталоге, и --project не меняет, куда они попадают. Предварительно просмотрите любую установку без записи файлов с помощью --dry-run:

apothem install --harness cursor --project . --dry-run
apothem install --harness cursor --project .

Установите весь набор, поддерживаемый реестром, сразу с помощью --harness all. Поскольку этот выбор записывает файлы уровня проекта и уровня пользователя, команда выводит конкретные цели, сгруппированные по расположению. В интерактивном терминале она запрашивает подтверждение перед записью за пределами корня проекта. Запуск без терминала, запуск с --yes или запуск с --format json выполняет запись без вопроса; --dry-run ничего не записывает. Запустите полный набор командой:

apothem install --harness all --project .

Все поддерживаемые имена см. в полном списке окружений, а полный набор параметров — в справочнике по install.

4. Проверка

Материализация — лишь половина работы: verify подтверждает, что ожидаемые файлы конфигурации окружения записаны и корректны:

apothem verify --harness claude-code
✓ claude-code is verified at /home/you/.claude/settings.json

verify завершается с ненулевым кодом, если управляемая цель отсутствует, управляемый файл пуст или конфигурация JSON или YAML не разбирается. Добавьте --profile PATH, чтобы команда также завершалась с ошибкой, когда установленный файл отличается от этого профиля; тогда verify становится проверкой дрейфа. Без этого параметра устаревшая конфигурация по-прежнему проходит проверку. Ненулевой код выхода позволяет использовать verify как шлюз в скрипте настройки. Для проверки работоспособности всей машины по всем зарегистрированным адаптерам выполните:

apothem doctor

doctor проверяет каждое установленное окружение: оно должно проходить проверку, и каждая команда хука, зарегистрированная при его установке, должна запускаться. Окружение, которое вы не установили, указывается в списке, но не считается сбоем, поэтому doctor завершается с кодом 0, если ни одна проверка не завершилась сбоем, даже когда установлено только одно окружение.

5. Ваш первый запуск

Откройте окружение, которое вы только что настроили, — в этом примере Claude Code — и начните сессию в любом проекте. Профиль, который вы настроили на шаге 2, теперь является частью поведения этого инструмента. Это и есть рабочий первый запуск: один профиль, формирующий реальную сессию.

Когда вы позже измените профиль, примените его повторно без переустановки:

apothem update --harness claude-code

Назовите другой адаптер, чтобы повторно применить профиль к этому инструменту (добавьте --project PATH для адаптера уровня проекта), или передайте --harness all --project ., чтобы повторно применить его ко всем поддерживаемым окружениям.

Следующие шаги

On this page