CLI
npm install -g instruction.md Офлайн, без облікового запису
| Команда | Що вона робить |
|---|---|
instruction validate <file> | перевіряє документ читачем специфікації: кожна проблема має свій рядок і сталий код. Помилки завершують команду невдачею (код виходу 1); попередження, як-от ${name}, якого ніщо не оголошує, показуються й не заважають, а з --strict невдачею завершуються і вони. Рядок, досі написаний за специфікацією 1.1, є помилкою |
instruction init <name> --template agent | початковий документ із правилами та їхніми причинами, умовою, людиною, яка затверджує, формою відповіді та глосарієм |
instruction deliver <file> name=value | точний текст, який отримує модель (instruction-text/1); основи та включення документа читаються з файлів поруч із ним; --resolved друкує розв’язаний документ (instruction-resolved/1) з його дайджестом |
instruction fmt <file> --write | обережне форматування: кінці рядків, останній символ нового рядка, пробіли в кінці рядків директив |
instruction tree <file> | дерево документа, як його написано (instruction/1), у форматі JSON |
instruction digest <file> | дайджест написаного документа: SHA-256 байтів файлу |
instruction render <file> --full | HTML для статичного сайту |
instruction test <dir> | запускає тестові вектори специфікації на відповідність, для вашого власного читача |
instruction eval <file> | запускає випадки :::eval документа на Claude з вашими власними обліковими даними; --dry-run показує, що надіслав би кожен випадок, і не викликає жодної моделі |
Робота з реєстром
Ці команди спілкуються із сервером за протоколом MCP 2026-07-28, без стану: сесії немає, і кожен запит самодостатній, хоч яка репліка сервера на нього відповість.
| Команда | Що вона робить |
|---|---|
instruction login | вхід у вашому браузері; дані входу зберігаються у вашому каталозі конфігурації |
instruction login --device | вхід за кодом на іншому пристрої, для машини без браузера (через SSH, у контейнері) |
instruction list, get, pull | знайти й отримати |
instruction push <file> --publish | створити або оновити чернетку й опублікувати її |
instruction publish <id> --tag v2 --refs latest,stable | опублікувати поточну чернетку й пересунути посилання (refs) |
instruction refs <id> set stable <ver> | пересунути посилання; саме так роблять відкат |
instruction diff <id> <from> <to> | різниця в уніфікованому форматі та на рівні блоків |
instruction watch <uri> --out FILE | стежити за посиланням, зберігаючи останню справну версію |
instruction connect --host claude-code <uri> --with-hooks --write | зробити інструкцію інструкцією проєкту в Claude Code або Codex (--host codex, Codex; англійською): файл прив’язки й хуки |
instruction hook claude-code, hook codex | що запускають ці хуки: інструкцію на початку сеансу й нову версію з наступним запитом |
instruction sync <uri> --as claude-skill | інструкція як субагент чи навичка Claude Code або навичка Codex (claude-agent, codex-skill) |
instruction connect --managed claude-code <uri> | налаштування, що ставлять її на кожен комп’ютер організації (керовані агенти, англійською) |
instruction audit export <id> --format csv | журнал аудиту, ніколи не вміст |
instruction revoke <id> <ver> | відкликати версію; отримувачі залишають ту, яку мали |
Вхід
instruction login відкриває у вашому браузері сторінку входу instruction.md. Увійдіть, погодьтеся
на те, про що просить командний рядок, і браузер покаже «You're signed in» (ви ввійшли): поверніться до
термінала. Браузер передає результат входу команді лише на вашому власному комп’ютері (на адресу на
127.0.0.1, відкриту для цього одного входу), а команда доводить, що саме вона почала вхід (PKCE),
тож вхід, який завершується деінде, відхиляється. Якщо за 5 хвилин нічого не повернулося, команда зупиняється
й повідомляє про це.
Для instruction.md команда входить лише на власній сторінці входу instruction.md, а для сервера, який ви назвали
через --url, — лише на сторінці входу на тій самій адресі, що й сервер. Сервер, який називає чужу
сторінку входу, міг би перехопити ваш вхід, тому він відхиляється; --issuer це скасовує, спершу
спитавши вас (або з --trust-issuer там, де немає термінала, щоб спитати), але власний вхід
instruction.md ніколи не використовується для іншого сервера. Кожен токен перевіряється: що він від того сервісу
входу, від якого надійшов, і для того сервера, до якого прямує. Вхід instruction.md ігнорує параметр
resource з RFC 8707, який надсилає команда, тож саме ця перевірка прив’язує токен до сервера.
На машині немає браузера, наприклад через SSH або в контейнері? Команда друкує посилання й пропонує
instruction login --device: вона показує короткий код і посилання, яке можна відкрити на будь-якому
пристрої, зокрема на телефоні. Код діє 5 хвилин.
Адміністрування організації (додавання чи ротація ключів видавця, створення чи відкликання агентів, журнал
аудиту) потребує ще одного дозволу. instruction login --admin просить його одразу; інакше перша
команда, якій він потрібен, питає вас у терміналі й виконує вхід знову, вже з ним. Без термінала вона нічого не
змінює і радить запустити instruction login --admin (--yes не починає входу), а вхід
під іншим обліковим записом відхиляється.
У CI
Задайте INSTRUCTION_MD_TOKEN для неінтерактивного токена й використовуйте --json, щоб
отримати машиночитний вивід. Коди виходу: 1 — помилка, 2 — неправильне використання, 3 — помилка зв’язку або вхід
не виконано, 4 — не знайдено, 5 — заборонено, 6 — нічого не застосовано, 7 — не підтверджено.
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with: { node-version: 22 }
- run: npm i -g instruction.md
- run: instruction validate RUNBOOK.md
- run: instruction push RUNBOOK.md --to ${{ vars.INSTRUCTION_ID }} --publish --yes --message "${{ github.sha }}" --json
env:
INSTRUCTION_MD_URL: https://instruction.md/mcp
INSTRUCTION_MD_TOKEN: ${{ secrets.INSTRUCTION_MD_TOKEN }}
Додайте --sign-with key.json, щоб публікувати з власним ключем, а не з ключем платформи.
Див. підписи та довіра.