https://github.com/axonops/axonops-workbench
AxonOps™ Workbench for Apache Cassandra® - Desktop application for Mac, Windows and Linux
https://github.com/axonops/axonops-workbench
apache-cassandra apache-cassandra-tools axonops cassandra cassandra-cluster cassandra-cql cassandra-database cassandra-driver cql cql-queries cqlsh database database-admin dba desktop desktop-app desktop-application desktop-apps desktop-client developer-tools
Last synced: about 1 month ago
JSON representation
AxonOps™ Workbench for Apache Cassandra® - Desktop application for Mac, Windows and Linux
- Host: GitHub
- URL: https://github.com/axonops/axonops-workbench
- Owner: axonops
- License: apache-2.0
- Created: 2024-03-04T13:00:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-04T11:18:45.000Z (about 2 months ago)
- Last Synced: 2025-04-04T12:22:46.445Z (about 2 months ago)
- Topics: apache-cassandra, apache-cassandra-tools, axonops, cassandra, cassandra-cluster, cassandra-cql, cassandra-database, cassandra-driver, cql, cql-queries, cqlsh, database, database-admin, dba, desktop, desktop-app, desktop-application, desktop-apps, desktop-client, developer-tools
- Language: JavaScript
- Homepage: https://axonops.com
- Size: 42.8 MB
- Stars: 13
- Watchers: 5
- Forks: 1
- Open Issues: 176
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# AxonOps Workbench
[AxonOps Workbench](https://axonops.com/workbench/) is a desktop application built for Cassandra DB developers and DBAs. Kafka support is coming soon!
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)
## Download and install
Go to https://axonops.com/workbench/download/ to download the latest release for your OS.
### Homebrew
For MacOS it is also possible to install the AxonOps Workbench using [brew](https://brew.sh/)
```sh
# 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
```sh
brew install --cask axonopsworkbench-beta
```
and for the daily internal builds (used for testing and development purposes) use
```sh
brew install --cask axonopsworkbench-internal
```
#### Docker or Podman on OSX
AxonOps Workbench requires docker with the docker compose plugin or podman with podman compse to start up and run local Apache Cassandra clusters.
`docker` does not run nativably on OSX. You usually need an additional application such as [Rancher Desktop](https://rancherdesktop.io/),
[Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/) or [Colima](https://github.com/abiosoft/colima).
- Ensure you list the [path where the docker command](./docs/docker-settings.png) is in the configuration
- Make sure you have installed the `docker-compose` plugin. If you're using `brew`, it's a simple as `brew install docker-compose`
- Ensure there is a symlink to the docker-compose binary in the configuration
```
cd ~/.docker/cli-plugins
ln -s $(brew --prefix)/bin/docker-compose .
```
## Features
### 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
## Software Bill of Materials (SBOM)
This project provides Software Bill of Materials (SBOM) files with each release, offering transparency into our software components and dependencies. SBOMs help users and organizations understand exactly what components are included in our software, enabling better security and compliance management.
**Available SBOM Formats**
- CycloneDX (sbom.cyclonedx.json): A lightweight SBOM standard that provides detailed component information and security context
- SPDX (sbom.spdx.json): A comprehensive format focusing on software licensing and component identification
**Benefits of Our SBOM**
- Security: Easily identify and track known vulnerabilities in dependencies
- Compliance: Verify license obligations for all included components
- Transparency: Clear visibility into the software supply chain
- Risk Management: Better understand and assess potential risks in the software stack
You can find our SBOM files in each [release](releases) as part of the release artifacts. These files are automatically generated during our build process to ensure they remain current with each release.
**Using SBOM Files**
- Download the SBOM file in your preferred format from the release assets
- Use SBOM analysis tools like:
- `cyclonedx-cli` for CycloneDX files
- `spdx-tools` for SPDX files
- Integrate with your security and compliance workflows
- Monitor for vulnerabilities in included components
We maintain these SBOM files as part of our commitment to software supply chain security and transparency. They are updated with each release to reflect the current state of our software dependencies.
## 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`
- Install required tools by running `./install_tools.sh`. It will download CQLSH binaries from [axonops-workbench-cqlsh](https://github.com/axonops/axonops-workbench-cqlsh/releases/latest).
- 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:
```sh
# 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.
### 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.
## Acknowledgements
AxonOps Workbench builds upon the foundation laid by several open-source projects, particularly Apache Cassandra. We extend our sincere gratitude to the Apache Cassandra community for their outstanding work and contributions to the field of distributed databases.
Apache Cassandra is a free and open-source, distributed, wide-column store, NoSQL database management system designed to handle large amounts of data across many commodity servers, providing high availability with no single point of failure.
### Apache Cassandra Resources
- **Official Website**: [cassandra.apache.org](https://cassandra.apache.org/)
- **Source Code**: Available on [GitHub](https://github.com/apache/cassandra) or the Apache Git repository at `gitbox.apache.org/repos/asf/cassandra.git`
- **Documentation**: Comprehensive guides and references available at the [Apache Cassandra website](https://cassandra.apache.org/)
AxonOps Workbench incorporates and extends functionality from various Cassandra tools and utilities, enhancing them to provide a seamless desktop experience for Cassandra DB developers and DBAs.
We encourage users to explore and contribute to the main Apache Cassandra project, as well as to provide feedback and suggestions for AxonOps Workbench through our [GitHub discussions](https://github.com/axonops/axonops-workbench/discussions/categories/ideas) and [issues](https://github.com/axonops/axonops-workbench/issues/new/choose) pages.
***
*This project may contain trademarks or logos for projects, products, or services. Any use of third-party trademarks or logos are subject to those third-party's policies. 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. Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries. Docker is a trademark or registered trademark of Docker, Inc. in the United States and/or other countries.*