ArangoDB v3.10 reached End of Life (EOL) and is no longer supported.
This documentation is outdated. Please see the most recent stable version.
Tools
ArangoDB ships with command-line tools like for accessing server instances programmatically, deploying clusters, creating backups, and importing data
A full ArangoDB installation package contains the ArangoDB server
(arangod) as well as the following client tools:
| Executable name | Brief description |
|---|---|
arangosh | ArangoDB shell. A client that implements a read-eval-print loop (REPL) and provides functions to access and administrate the ArangoDB server. |
arangodb | ArangoDB Starter for easy deployment of ArangoDB instances. |
arangodump | Tool to create backups of an ArangoDB database. |
arangorestore | Tool to load backups back into an ArangoDB database. |
arangobackup | Tool to perform hot backup operations on an ArangoDB installation. |
arangoimport | Bulk importer for the ArangoDB server. It supports JSON and CSV. |
arangoexport | Bulk exporter for the ArangoDB server. It supports JSON, CSV and XML. |
arangobench | Benchmark and test tool. It can be used for performance and server function testing. |
arangovpack | Utility to validate and convert VelocyPack and JSON data. |
arangoinspect | Inspection tool that gathers server setup information. |
A client installation package comes without the arangod server executable and
the ArangoDB Starter.
Additional tools which are available separately:
| Name | Brief description |
|---|---|
| Foxx CLI | Command line tool for managing and developing Foxx services |
| kube-arangodb | Operators to manage Kubernetes deployments |
| Oasisctl | Command-line tool for managing the ArangoGraph Insights Platform |