Installation

Cyphernetes can be installed in multiple ways depending on your operating system and preferences.

Homebrew

The easiest way to install Cyphernetes on macOS or Linux is via Homebrew:

brew install cyphernetes

Using go get

   go install github.com/avitaltamir/cyphernetes/cmd/cyphernetes@latest

Binary Download

You can download the pre-compiled binary for your operating system:

Linux

# For AMD64
curl -LO https://github.com/avitaltamir/cyphernetes/releases/latest/download/cyphernetes-linux-amd64
chmod +x cyphernetes-linux-amd64
sudo mv cyphernetes-linux-amd64 /usr/local/bin/cyphernetes

# For ARM64
curl -LO https://github.com/avitaltamir/cyphernetes/releases/latest/download/cyphernetes-linux-arm64
chmod +x cyphernetes-linux-arm64
sudo mv cyphernetes-linux-arm64 /usr/local/bin/cyphernetes

macOS

# For AMD64
curl -LO https://github.com/avitaltamir/cyphernetes/releases/latest/download/cyphernetes-darwin-amd64
chmod +x cyphernetes-darwin-amd64
sudo mv cyphernetes-darwin-amd64 /usr/local/bin/cyphernetes

# For ARM64 (Apple Silicon)
curl -LO https://github.com/avitaltamir/cyphernetes/releases/latest/download/cyphernetes-darwin-arm64
chmod +x cyphernetes-darwin-arm64
sudo mv cyphernetes-darwin-arm64 /usr/local/bin/cyphernetes

Windows

Download the latest Windows binary from our releases page.

Build from Source

To build Cyphernetes from source, you'll need:

• Go (Latest)
• Make
• NodeJS (Latest)
• pnpm (9+)

# Clone the repository
git clone https://github.com/avitaltamir/cyphernetes.git

# Navigate to the project directory
cd cyphernetes

# Build the project
make

# The binary will be available in the dist/ directory
sudo mv dist/cyphernetes /usr/local/bin/cyphernetes

Verifying the Installation

After installation, verify that Cyphernetes is working correctly:

cyphernetes --version

Running Cyphernetes

There are multiple ways to run Cyphernetes:

1. Web Interface

   cyphernetes web

   Then visit http://localhost:8080 in your browser.

2. Interactive Shell

   cyphernetes shell

3. Single Query

   cyphernetes query "MATCH (p:Pod) RETURN p"