Skip to content

Docs: Homebrew setup and devkit.properties user settings - #199

Merged
satran004 merged 2 commits into
mainfrom
docs/homebrew-devkit-properties
Oct 14, 2026
Merged

satran004 merged 2 commits into
mainfrom
docs/homebrew-devkit-properties

Conversation

@satran004

@satran004 satran004 commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Documents the Homebrew distribution and ~/.yaci-cli/devkit.properties, both added in #198 and released in v0.12.0.

Changes

  • New page: Getting Started > Homebrew Setup (getting-started/homebrew.mdx)
    • brew install bloxbean/tap/yaci-devkit (stable) or bloxbean/tap/yaci-devkit-beta. Both install the yaci-devkit command, so install only one.
    • Switching from npm: remove the npm install first, including an old sudo npm -g one in /usr/local/bin, which comes before Homebrew on the PATH.
    • Upgrade, uninstall (keeps ~/.yaci-cli), usage, Yaci Viewer via npm.
    • Requirements: macOS 15 (arm64) or later, or Linux x64.
  • New page: User Settings (user-settings.mdx) for ~/.yaci-cli/devkit.properties
    • Read by the Homebrew, npm and zip distributions, not Docker.
    • Can hold any key from application.properties, node.properties or download.properties, and is kept across upgrades.
    • Precedence: command options > -D > environment variables > devkit.properties > bundled config.
    • Always in $HOME/.yaci-cli, even with a custom yaci.cli.home. Re-create the devnet after changing genesis or node settings. Use absolute paths.
  • Links from existing pages
    • Introduction: adds the Homebrew distribution and changes "macOS arm64" to "macOS 15 (arm64) or later".
    • NPM and Zip: link to User Settings. The Zip upgrade note (rm -rf ~/.yaci-cli) now warns that this also deletes devkit.properties.
    • Known Issues: the Prometheus port workaround now covers Homebrew and devkit.properties.
  • Stale warning removed from the Zip page (and not copied to Homebrew): it said Ogmios/Kupo run only on Linux x86_64. Ogmios v7.0.0 and Kupo v2.12.0 publish aarch64-macos builds, which DownloadService already selects. Both run on macOS (--version checked on Apple Silicon), as Known Issues and the npm README already say.

Testing

  • next build in docs/ succeeds, and /getting-started/homebrew and /user-settings are generated.

🤖 Generated with Claude Code

satran004 and others added 2 commits October 14, 2026 19:37
- New Getting Started page for the Homebrew formulas (yaci-devkit, yaci-devkit-beta):
  install, switching from npm, upgrade, uninstall
- New User Settings page for ~/.yaci-cli/devkit.properties: read by the Homebrew, npm and zip
  distributions (not Docker), precedence, and when to re-create the devnet
- Link both from the introduction, npm, zip and known-issues pages; macOS 15 in the introduction

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ogmios v7.0.0 and Kupo v2.12.0 publish aarch64-macos builds, which DownloadService already selects
(as Known Issues and the npm README say). Remove the warning from the Zip and Homebrew pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@satran004
satran004 merged commit 9e0c288 into main Oct 14, 2026
2 checks passed
@satran004
satran004 deleted the docs/homebrew-devkit-properties branch October 14, 2026 13:37
satran004 added a commit that referenced this pull request Oct 14, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant