diff --git a/content/docs/introduction/install.mdx b/content/docs/introduction/install.mdx index ec3b82b..b323c8c 100644 --- a/content/docs/introduction/install.mdx +++ b/content/docs/introduction/install.mdx @@ -2,17 +2,15 @@ title: "Install EasyP" --- - -Install EasyP v1 only by an explicitly selected, published nightly tag. The default stable installation remains v0.17.0 while v1 has only prerelease tags. To use the v1 configuration and commands in these docs, follow [the nightly instructions](#opt-into-v1-nightly). - +EasyP v1 is the current release. Every channel below installs it; projects still on v0 can move with [`easyp migrate`](/docs/migration/easyp-v0). -## Install the stable CLI +## Install the CLI - + #### Homebrew - You can install a binary release on macOS using brew: + On macOS or Linux, the formula installs both `easyp` and the `easyp-mcp` server: ```bash brew install easyp-tech/tap/easyp @@ -23,82 +21,58 @@ Install EasyP v1 only by an explicitly selected, published nightly tag. The defa #### Go toolchain - Install the latest published stable version using the Go toolchain required by that release: + Building v1 requires **Go 1.26.6 or later**: ```bash go install github.com/easyp-tech/easyp/cmd/easyp@latest + go install github.com/easyp-tech/easyp/cmd/easyp-mcp@latest ``` - Download the archive for your OS and architecture from the [latest stable release](https://github.com/easyp-tech/easyp/releases/latest). Extract it and place the `easyp` binary on `PATH`. - - - -The stable Docker channel is `ghcr.io/easyp-tech/easyp:latest`; it currently -points to the same image as `ghcr.io/easyp-tech/easyp:v0.17.0`. + Every archive contains both `easyp` and `easyp-mcp`. Download the one for your OS and architecture from the [latest release](https://github.com/easyp-tech/easyp/releases/latest) and verify it with the release checksums. For Linux amd64: -## Opt into v1 nightly - -Nightly tags use `v1.0.0-nightly.YYYYMMDD.sequence`. The commands below pin [v1.0.0-nightly.20261009.1](https://github.com/easyp-tech/easyp/releases/tag/v1.0.0-nightly.20261009.1). To select another version, choose an exact published tag from [GitHub Releases](https://github.com/easyp-tech/easyp/releases). Nightly releases do not update the stable Homebrew formula or Docker `latest` image. + ```bash + TAG=$(curl -fsSL https://api.github.com/repos/easyp-tech/easyp/releases/latest | sed -n 's/.*"tag_name": *"\([^"]*\)".*/\1/p') + VERSION="${TAG#v}" + ASSET="easyp-${VERSION}-linux-amd64.tar.gz" + curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${TAG}/${ASSET}" + curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${TAG}/easyp-${VERSION}-checksums.txt" + sha256sum --check --ignore-missing "easyp-${VERSION}-checksums.txt" + tar -xzf "$ASSET" + sudo install "easyp-${VERSION}-linux-amd64/easyp" "easyp-${VERSION}-linux-amd64/easyp-mcp" /usr/local/bin/ + ``` -### Go: CLI and MCP + macOS archives use `darwin`; Windows archives use `.zip` and contain `.exe` binaries. No Go toolchain is needed to run these binaries. + + + The CLI image is published to GHCR as `latest` and as each exact release tag: -Building v1 requires **Go 1.26.6 or later**. Install both binaries at the same exact version in a separate directory to keep your stable CLI on `PATH`: + ```bash + docker run --rm -v "$PWD:/workspace" -w /workspace \ + ghcr.io/easyp-tech/easyp:latest --version + ``` -```bash -# Select an exact published nightly tag. -NIGHTLY_TAG='v1.0.0-nightly.20261009.1' -NIGHTLY_BIN="$HOME/.local/share/easyp-nightly/bin" -mkdir -p "$NIGHTLY_BIN" -GOBIN="$NIGHTLY_BIN" go install "github.com/easyp-tech/easyp/cmd/easyp@${NIGHTLY_TAG}" -GOBIN="$NIGHTLY_BIN" go install "github.com/easyp-tech/easyp/cmd/easyp-mcp@${NIGHTLY_TAG}" -"$NIGHTLY_BIN/easyp" --version -``` + Replace `--version` with the EasyP command you need, and pin an exact tag in CI. This image contains the CLI; use Homebrew, Go install or an archive for the MCP stdio server. + + -Invoke the nightly CLI by its full path. Configure your MCP client to run the `easyp-mcp` binary from this directory as a stdio server; it exposes the v1 configuration reference through `easyp_config_describe`. To run the v1 examples with bare `easyp` commands, select the nightly for that terminal session with `export PATH="$NIGHTLY_BIN:$PATH"`. Keep it off your permanent `PATH` to retain stable defaults. +Configure your MCP client to run `easyp-mcp` as a stdio server; it exposes the v1 configuration reference through `easyp_config_describe`. -### Release archive: CLI and MCP +## Staying on v0 -The v1 archive contains both `easyp` and `easyp-mcp`. Download the asset matching your platform and verify it with the release checksums. For Linux amd64: +v0 remains available by its exact version, for projects that have not migrated yet or to record a baseline before migrating: ```bash -# Select an exact published nightly tag. -NIGHTLY_TAG='v1.0.0-nightly.20261009.1' -NIGHTLY_VERSION="${NIGHTLY_TAG#v}" -NIGHTLY_ASSET="easyp-${NIGHTLY_VERSION}-linux-amd64.tar.gz" -NIGHTLY_BIN="$HOME/.local/share/easyp-nightly/bin" -curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${NIGHTLY_TAG}/${NIGHTLY_ASSET}" -curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${NIGHTLY_TAG}/easyp-${NIGHTLY_VERSION}-checksums.txt" -sha256sum --check --ignore-missing "easyp-${NIGHTLY_VERSION}-checksums.txt" -mkdir -p "$NIGHTLY_BIN" -tar -xzf "$NIGHTLY_ASSET" --strip-components=1 -C "$NIGHTLY_BIN" -"$NIGHTLY_BIN/easyp" --version +go install github.com/easyp-tech/easyp/cmd/easyp@v0.17.0 +docker run --rm -v "$PWD:/workspace" -w /workspace ghcr.io/easyp-tech/easyp:v0.17.0 --version ``` -Invoke the CLI and MCP binaries by their full paths in this separate directory. macOS archives use `darwin`; Windows archives use `.zip` and contain `.exe` binaries. No Go toolchain is needed to run these binaries. - -### Docker: CLI - -The nightly CLI image uses its exact tag in GHCR: +## Prereleases -```bash -# Select an exact published nightly tag. -NIGHTLY_TAG='v1.0.0-nightly.20261009.1' -docker run --rm -v "$PWD:/workspace" -w /workspace \ - "ghcr.io/easyp-tech/easyp:${NIGHTLY_TAG}" --version -``` - -Replace `--version` with the EasyP command you need. This image contains the CLI; use the Go install or archive for the MCP stdio server. +Prerelease builds are published as `v1.X.Y-nightly.YYYYMMDD.N` tags on [GitHub Releases](https://github.com/easyp-tech/easyp/releases) and as `ghcr.io/easyp-tech/easyp:`. They are installed only by their exact tag, for example `go install github.com/easyp-tech/easyp/cmd/easyp@`, and never update Homebrew, Go `@latest` or the Docker `latest` image. ## Go modules: moving from v0 to v1 -EasyP v0 and v1 share the module path `github.com/easyp-tech/easyp`; there is no `/v1` suffix. Go requires a new `/v2` path starting at major version 2 so incompatible major versions can coexist. A v0→v1 upgrade can still require changes to your code and configuration. See [Go's version numbering](https://go.dev/doc/modules/version-numbers). - -Merging v1 development into `main` leaves the published `v0.17.0` tag and pinned v0 installations unchanged. When starting from v0, `@latest` and ordinary `go get -u` prefer a published stable version over v1 prereleases; explicitly requesting a nightly opts into v1 and its API/configuration changes. An existing requirement on a higher prerelease is not automatically downgraded. See [Go version queries](https://go.dev/ref/mod#version-queries). - -A stable `v1.0.0` Git tag would become eligible for Go's default selection even without a GitHub Release, or if that Release were marked prerelease. For this nightly-only phase, publish only the exact nightly tag format above. `@main` explicitly requests development code; it is not the stable installation channel. +EasyP v0 and v1 share the module path `github.com/easyp-tech/easyp`; there is no `/v1` suffix. Go requires a new `/v2` path starting at major version 2 so incompatible major versions can coexist. See [Go's version numbering](https://go.dev/doc/modules/version-numbers). -Go selects one version per module path for a build. A different dependency -requiring a v1 nightly can also raise the selected EasyP version through -[minimal version selection](https://go.dev/ref/mod#minimal-version-selection). -Library consumers keeping v0 need a dependency graph compatible with that version. +Code that imports EasyP as a library therefore moves to v1 on `go get -u` or `@latest`, and the v1 API and configuration may require changes. Pin `v0.17.0` until that code is ported. Go selects one version per module path for a build, so a different dependency requiring v1 can also raise the selected EasyP version through [minimal version selection](https://go.dev/ref/mod#minimal-version-selection). diff --git a/content/docs/introduction/install.ru.mdx b/content/docs/introduction/install.ru.mdx index d40ce86..442d9e1 100644 --- a/content/docs/introduction/install.ru.mdx +++ b/content/docs/introduction/install.ru.mdx @@ -2,103 +2,77 @@ title: "Установка EasyP" --- - -Для установки EasyP v1 явно выберите опубликованный nightly-тег. Стабильная установка по умолчанию остаётся на v0.17.0, пока для v1 существуют только prerelease-теги. Для конфигурации и команд v1 из этой документации используйте [инструкцию nightly](#явная-установка-v1-nightly). - +Текущий релиз — EasyP v1. Все способы ниже устанавливают его; проекты на v0 переводятся командой [`easyp migrate`](/ru/docs/migration/easyp-v0). -## Установка стабильного CLI +## Установка CLI - + #### Homebrew - Можно установить бинарный релиз в macOS через Homebrew: + На macOS и Linux формула устанавливает `easyp` и MCP-сервер `easyp-mcp`: ```bash brew install easyp-tech/tap/easyp ``` - `Work in progress` — поддержка других системных менеджеров (apt, yum, pacman и т.д.) в процессе. + `Work in progress`: поддержка apt, yum, pacman и других менеджеров в разработке. #### Go toolchain - Установите последнюю опубликованную стабильную версию через Go toolchain, требуемый выбранным релизом: + Для сборки v1 нужен **Go 1.26.6 или новее**: ```bash go install github.com/easyp-tech/easyp/cmd/easyp@latest + go install github.com/easyp-tech/easyp/cmd/easyp-mcp@latest ``` - Скачайте архив для своей ОС и архитектуры из [последнего стабильного релиза](https://github.com/easyp-tech/easyp/releases/latest). Распакуйте его и добавьте бинарник `easyp` в `PATH`. - - - -Стабильный Docker-канал — `ghcr.io/easyp-tech/easyp:latest`; сейчас он указывает -на тот же образ, что и `ghcr.io/easyp-tech/easyp:v0.17.0`. + Каждый архив содержит `easyp` и `easyp-mcp`. Скачайте архив для своей ОС и архитектуры из [последнего релиза](https://github.com/easyp-tech/easyp/releases/latest) и проверьте его по контрольным суммам релиза. Для Linux amd64: -## Явная установка v1 nightly - -Nightly-теги имеют формат `v1.0.0-nightly.YYYYMMDD.sequence`. Команды ниже закреплены на [v1.0.0-nightly.20261009.1](https://github.com/easyp-tech/easyp/releases/tag/v1.0.0-nightly.20261009.1). Для другой версии выберите точный опубликованный тег в [GitHub Releases](https://github.com/easyp-tech/easyp/releases). Nightly не обновляет стабильную формулу Homebrew или Docker-образ `latest`. + ```bash + TAG=$(curl -fsSL https://api.github.com/repos/easyp-tech/easyp/releases/latest | sed -n 's/.*"tag_name": *"\([^"]*\)".*/\1/p') + VERSION="${TAG#v}" + ASSET="easyp-${VERSION}-linux-amd64.tar.gz" + curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${TAG}/${ASSET}" + curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${TAG}/easyp-${VERSION}-checksums.txt" + sha256sum --check --ignore-missing "easyp-${VERSION}-checksums.txt" + tar -xzf "$ASSET" + sudo install "easyp-${VERSION}-linux-amd64/easyp" "easyp-${VERSION}-linux-amd64/easyp-mcp" /usr/local/bin/ + ``` -### Go: CLI и MCP + Архивы для macOS называются `darwin`; для Windows используется `.zip` с бинарниками `.exe`. Для запуска бинарников Go не нужен. + + + Образ CLI публикуется в GHCR с тегом `latest` и с точным тегом каждого релиза: -Для сборки v1 требуется **Go 1.26.6 или новее**. Установите оба бинарника в одной точной версии в отдельный каталог, чтобы сохранить стабильный CLI в `PATH`: + ```bash + docker run --rm -v "$PWD:/workspace" -w /workspace \ + ghcr.io/easyp-tech/easyp:latest --version + ``` -```bash -# Выберите точный опубликованный nightly-тег. -NIGHTLY_TAG='v1.0.0-nightly.20261009.1' -NIGHTLY_BIN="$HOME/.local/share/easyp-nightly/bin" -mkdir -p "$NIGHTLY_BIN" -GOBIN="$NIGHTLY_BIN" go install "github.com/easyp-tech/easyp/cmd/easyp@${NIGHTLY_TAG}" -GOBIN="$NIGHTLY_BIN" go install "github.com/easyp-tech/easyp/cmd/easyp-mcp@${NIGHTLY_TAG}" -"$NIGHTLY_BIN/easyp" --version -``` + Замените `--version` нужной командой EasyP, а в CI закрепляйте точный тег. В образе только CLI; MCP-сервер ставьте через Homebrew, Go install или архив. + + -Вызывайте nightly CLI по полному пути. Настройте MCP-клиент на запуск `easyp-mcp` из этого каталога как stdio-сервера: он предоставляет справочник конфигурации v1 через `easyp_config_describe`. Для примеров с командой `easyp` выберите nightly в текущем терминале: `export PATH="$NIGHTLY_BIN:$PATH"`. Не добавляйте этот каталог в постоянный `PATH`, чтобы сохранить стабильную версию по умолчанию. +Подключите `easyp-mcp` в MCP-клиенте как stdio-сервер: он отдаёт справочник конфигурации v1 через `easyp_config_describe`. -### Архив релиза: CLI и MCP +## Если нужно остаться на v0 -Архив v1 содержит `easyp` и `easyp-mcp`. Скачайте файл для своей платформы и проверьте его по контрольным суммам релиза. Пример для Linux amd64: +v0 доступен по точной версии — для проектов, которые ещё не мигрировали, или чтобы снять эталон перед миграцией: ```bash -# Выберите точный опубликованный nightly-тег. -NIGHTLY_TAG='v1.0.0-nightly.20261009.1' -NIGHTLY_VERSION="${NIGHTLY_TAG#v}" -NIGHTLY_ASSET="easyp-${NIGHTLY_VERSION}-linux-amd64.tar.gz" -NIGHTLY_BIN="$HOME/.local/share/easyp-nightly/bin" -curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${NIGHTLY_TAG}/${NIGHTLY_ASSET}" -curl -fLO "https://github.com/easyp-tech/easyp/releases/download/${NIGHTLY_TAG}/easyp-${NIGHTLY_VERSION}-checksums.txt" -sha256sum --check --ignore-missing "easyp-${NIGHTLY_VERSION}-checksums.txt" -mkdir -p "$NIGHTLY_BIN" -tar -xzf "$NIGHTLY_ASSET" --strip-components=1 -C "$NIGHTLY_BIN" -"$NIGHTLY_BIN/easyp" --version +go install github.com/easyp-tech/easyp/cmd/easyp@v0.17.0 +docker run --rm -v "$PWD:/workspace" -w /workspace ghcr.io/easyp-tech/easyp:v0.17.0 --version ``` -Вызывайте CLI и MCP по полным путям в этом отдельном каталоге. Архивы macOS используют `darwin`; архивы Windows имеют расширение `.zip` и содержат `.exe`. Для запуска готовых бинарников Go toolchain не нужен. - -### Docker: CLI - -Nightly-образ CLI в GHCR выбирается по точному тегу: +## Предрелизы -```bash -# Выберите точный опубликованный nightly-тег. -NIGHTLY_TAG='v1.0.0-nightly.20261009.1' -docker run --rm -v "$PWD:/workspace" -w /workspace \ - "ghcr.io/easyp-tech/easyp:${NIGHTLY_TAG}" --version -``` - -Замените `--version` нужной командой EasyP. Образ содержит CLI; MCP stdio-сервер устанавливается через Go или архив. +Предрелизные сборки публикуются тегами `v1.X.Y-nightly.YYYYMMDD.N` на [GitHub Releases](https://github.com/easyp-tech/easyp/releases) и образами `ghcr.io/easyp-tech/easyp:`. Они ставятся только по точному тегу, например `go install github.com/easyp-tech/easyp/cmd/easyp@`, и никогда не обновляют Homebrew, Go `@latest` и Docker-образ `latest`. ## Go modules: переход с v0 на v1 -EasyP v0 и v1 используют один путь модуля: `github.com/easyp-tech/easyp`, без суффикса `/v1`. Начиная с major 2 Go требует новый путь `/v2`, чтобы несовместимые мажорные версии могли сосуществовать. Переход v0→v1 всё же может требовать изменений кода и конфигурации. См. [нумерацию версий Go](https://go.dev/doc/modules/version-numbers). - -Слияние разработки v1 в `main` не меняет опубликованный тег `v0.17.0` и установки, закреплённые на v0. При переходе со стабильного v0 команды `@latest` и обычный `go get -u` предпочитают опубликованную стабильную версию prerelease-версиям v1. Явный nightly-тег включает v1 и требует учёта изменений API и конфигурации. Уже выбранная более высокая prerelease-версия автоматически не понижается. См. [запросы версий Go](https://go.dev/ref/mod#version-queries). - -Стабильный Git-тег `v1.0.0` попадёт в выбор Go по умолчанию даже без GitHub Release или при флаге prerelease у этого Release. На этапе nightly публикуются только точные nightly-теги указанного выше формата. `@main` явно запрашивает код разработки и не является каналом стабильной установки. +EasyP v0 и v1 используют один путь модуля `github.com/easyp-tech/easyp`, суффикса `/v1` нет. Go требует новый путь `/v2` начиная со второй мажорной версии, чтобы несовместимые версии могли сосуществовать. См. [нумерацию версий Go](https://go.dev/doc/modules/version-numbers). -Для одной сборки Go выбирает одну версию каждого module path. Другая зависимость, -требующая v1 nightly, также может повысить выбранную версию EasyP через -[minimal version selection](https://go.dev/ref/mod#minimal-version-selection). -Если вы используете v0 как библиотеку, её граф зависимостей тоже должен быть совместим с v0. +Поэтому код, который импортирует EasyP как библиотеку, перейдёт на v1 при `go get -u` или `@latest`, а API и конфигурация v1 могут потребовать изменений. Закрепите `v0.17.0`, пока код не перенесён. Go выбирает одну версию на путь модуля в сборке, поэтому другая зависимость, требующая v1, тоже может поднять выбранную версию EasyP через [minimal version selection](https://go.dev/ref/mod#minimal-version-selection). diff --git a/content/docs/introduction/quickstart.mdx b/content/docs/introduction/quickstart.mdx index dc28e1d..1783b3b 100644 --- a/content/docs/introduction/quickstart.mdx +++ b/content/docs/introduction/quickstart.mdx @@ -1,15 +1,13 @@ --- title: "Quickstart" -description: "Create a protobuf module and generate code with EasyP v1 nightly." +description: "Create a protobuf module and generate code with EasyP v1." --- -Install an [explicit v1 nightly](/docs/introduction/install#opt-into-v1-nightly) and make sure Git is available. The `go` plugin uses `protoc-gen-go` from `PATH` when installed, otherwise EasyP uses its bundled WASM generator. +[Install EasyP v1](/docs/introduction/install) and make sure Git is available. The `go` plugin uses `protoc-gen-go` from `PATH` when installed, otherwise EasyP uses its bundled WASM generator. ## 1. Initialize a module ```bash -# Use the nightly installed in the installation guide for this terminal session. -export PATH="$HOME/.local/share/easyp-nightly/bin:$PATH" easyp --version mkdir contracts && cd contracts diff --git a/content/docs/introduction/quickstart.ru.mdx b/content/docs/introduction/quickstart.ru.mdx index c96600d..61286ff 100644 --- a/content/docs/introduction/quickstart.ru.mdx +++ b/content/docs/introduction/quickstart.ru.mdx @@ -1,15 +1,13 @@ --- title: "Быстрый старт" -description: "Создание protobuf-модуля и генерация кода в EasyP v1 nightly." +description: "Создание protobuf-модуля и генерация кода в EasyP v1." --- -Установите [явно выбранный v1 nightly](/ru/docs/introduction/install#явная-установка-v1-nightly) и убедитесь, что доступен Git. Плагин `go` использует `protoc-gen-go` из `PATH`, если он установлен; иначе EasyP запускает встроенный WASM-генератор. +[Установите EasyP v1](/ru/docs/introduction/install) и убедитесь, что доступен Git. Плагин `go` использует `protoc-gen-go` из `PATH`, если он установлен; иначе EasyP запускает встроенный WASM-генератор. ## 1. Создайте модуль ```bash -# Выберите nightly из инструкции по установке для текущего терминала. -export PATH="$HOME/.local/share/easyp-nightly/bin:$PATH" easyp --version mkdir contracts && cd contracts