homebrew-tap

Homebrew tap for OpenOctopus — install with brew install openoctopus.

---

Status: Phase 3 — Planned. Part of the OpenOctopus ecosystem roadmap. Homebrew distribution launches after core product stabilizes. Phase 1 focuses on chat-native family hub (Telegram/WeChat/Web).

What is homebrew-tap?

homebrew-tap is the official Homebrew tap for installing OpenOctopus on macOS and Linux. It provides formulae for the tentacle CLI tool and the ink gateway.

Planned Installation

# Add the tap
brew tap open-octopus/tap

# Install the CLI
brew install openoctopus

# Or install directly
brew install open-octopus/tap/openoctopus

What Gets Installed

Formula	Binary	Description
openoctopus	tentacle	CLI tool — chat, manage realms, summon entities
openoctopus	ink	Agent gateway (runs as background service)

Dependencies installed automatically: Node.js 22

Quick Start

# Initialize configuration (creates ~/.openoctopus/config.json5)
tentacle config init

# Set your API key (or add to config.json5)
export ANTHROPIC_API_KEY=sk-ant-...

# Start the gateway as a background service
brew services start openoctopus

# Verify the gateway is running
tentacle status

# Start chatting
tentacle chat

Post-Install Verification

# Check service status
brew services info openoctopus

# Check gateway health
curl http://localhost:19790/healthz

# Check version
tentacle --version

# View gateway logs
tail -50 $(brew --prefix)/var/log/openoctopus.log

Updating

# Update to the latest version
brew upgrade openoctopus

# Restart the service after update
brew services restart openoctopus

Uninstalling

# Stop the service
brew services stop openoctopus

# Uninstall
brew uninstall openoctopus

# (Optional) Remove config and data
rm -rf ~/.openoctopus

Troubleshooting

Issue	Solution
Gateway won't start	Check logs: tail -50 $(brew --prefix)/var/log/openoctopus.log
Port conflict on 19789	Check: lsof -i :19789 — stop conflicting process or change port in config
tentacle: command not found	Run brew link openoctopus or check echo $PATH
API key error	Set ANTHROPIC_API_KEY env var or add to ~/.openoctopus/config.json5

Planned Repository Structure

homebrew-tap/
├── Formula/
│   └── openoctopus.rb     # Main formula
├── Casks/
│   └── (future: desktop app)
└── README.md

Formula Example

class Openoctopus < Formula
  desc "AI family home hub"
  homepage "https://openoctopus.club"
  url "https://github.com/open-octopus/openoctopus/releases/download/v#{version}/openoctopus-#{version}.tar.gz"
  license "MIT"

  depends_on "node@22"

  def install
    # Install tentacle CLI and ink gateway
  end

  service do
    run [opt_bin/"ink", "--port", "19789"]
    keep_alive true
    log_path var/"log/openoctopus.log"
  end

  test do
    system "#{bin}/tentacle", "--version"
  end
end

Roadmap

• Create formula for tentacle CLI
• Add brew services support for ink gateway
• Automated formula updates on release (GitHub Actions)
• Cask for future desktop app
• Bottle (pre-built binary) support for faster installs

Related Projects

Project	Description
openoctopus	Core monorepo — tentacle CLI and ink gateway source
openoctopus-ansible	Self-hosted deployment (alternative to Homebrew)

Contributing

See CONTRIBUTING.md for general guidelines.

License

MIT — see the .github repo for the full license text.