AxonOps™ Workbench for Apache Cassandra®

AxonOps Workbench for Apache Cassandra is a desktop application built for Cassandra DB developers and DBAs. Seamlessly connect and interact with Apache Cassandra clusters while enjoying a host of innovative enhancements and exciting features.

We welcome your feedback, so feel free to discuss any ideas you have https://github.com/axonops/axonops-workbench/discussions/categories/ideas or raise issues any issues (https://github.com/axonops/axonops-workbench/issues/new/choose)

New CQL Console

Query Tracing

AI Assistant (Experimental)

Organise clusters into workspaces and securely add to source control for sharing

Run local Cassandra clusters

Built in SSH tunneling

Download and install

Browse to the releases and select the package for your Operating System. We prebuild distributions for

• OSX (Intel and Apple chips)
• Linux (RedHat, Debian and others)
• Windows (Intel)

For MacOS it is also possible to install the AxonOps Workbench using brew

# Optional: set applications directory to your $HOME
export HOMEBREW_CASK_OPTS="--appdir=~/Applications"
brew tap axonops/homebrew-repository
brew install --cask axonopsworkbench

If you'd like to use a beta release use instead

brew install --cask axonopsworkbench-beta

and for the daily internal builds (used for testing and development purposes) use

brew install --cask axonopsworkbench-internal

Tidying up between beta release installs

The current builds are still in development and are not necessarily backwards compatible, so do this before taking a new beta release

Linux and macOS:

• Delete the folder(s) with perfix .axonops- in the home folder.
• In the OS Keychain, remove all keys with prefix AxonOps.

Windows:

• Delete the folder with prefix axonops- in the user directory folder C:\Users{username}.
• Delete the folder with prefix AxonOps in apps' data folder C:\Users{username}\AppData\Roaming or %appData%.
• In the Windows Credential Manager, remove all credentials with prefix AxonOps.
• In the registries - using the regedit tool -, navigate to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\AxonOpsWorkbenchClustersSecrets - it can also be AxonOpsDeveloperWorkbenchClustersSecrets -, delete the entire key/folder.

Development

If you would like to run it in development, please follow the instructions below.

Requirements

• nodejs >= 20.15.0
• npm >= 10.7.0
• python >= 3.12

Installation & Running

• Clone this repository
• Install python dependencies pip3 install -r requirements.txt
• Download CQLSH binaries from axonops-workbench-cqlsh
  • cqlsh binary has to be placed in main/bin/cqlsh/cqlsh
  • keys_generator binary has to be placed in main/bin/keys_generator/keys_generator
• Run npm i to install the nodejs dependencies
• Execute npm start to run it in development mode

Debugging

• You can set the environment variable AXONOPS_DEV_TOOLS=true to open the developer tools on start up
• Using VSCode, you can use Main + Renderer compound launch configuration to debug main process and rendereres simultaneously

Packaging

If you'd like to create your own distribution package, you will need to install electron-builder and then run the following:

# builds linux deb, rpm and tar.gz
npm run linux
# OSX dmg and zip
npm run mac
# windows
npm run win

See the packages.json for other build options.

---

AxonOps is a registered trademark of AxonOps Limited. Apache, Apache Cassandra, Cassandra, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.