https://github.com/dicedb/dicedb-cli
A command line interface for DiceDB
https://github.com/dicedb/dicedb-cli
Last synced: over 1 year ago
JSON representation
A command line interface for DiceDB
- Host: GitHub
- URL: https://github.com/dicedb/dicedb-cli
- Owner: DiceDB
- License: bsd-3-clause
- Created: 2024-10-20T05:17:32.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-25T17:40:48.000Z (over 1 year ago)
- Last Synced: 2025-03-03T05:35:52.885Z (over 1 year ago)
- Language: Go
- Homepage: https://dicedb.io
- Size: 64.5 KB
- Stars: 19
- Watchers: 4
- Forks: 28
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DiceDB CLI
This is a command line interface for [DiceDB](https://dicedb.io).
## Get Started
### Using cURL
The best way to connect to DiceDB is using [DiceDB CLI](https://github.com/dicedb/dicedb-cli) and you can install it by running the following command
```bash
$ sudo su
$ curl -sL https://raw.githubusercontent.com/dicedb/dicedb-cli/refs/heads/master/install.sh | sh
```
If you are working on unsupported OS (as per above script), you can always follow the installation instructions mentioned in the [dicedb/cli](https://github.com/dicedb/dicedb-cli) repository.
### Building from source
```sh
$ git clone https://github.com/dicedb/dicedb-cli
$ cd dicedb-cli
$ make build
```
The above command will create a binary `dicedb-cli`. Execute the binary will
start the CLI and will try to connect to the DiceDB server.
## Usage
Run the executable to start the interactive prompt (REPL)
```bash
$ dicedb-cli
```
You should see
```sh
localhost:7379>
```
To connect to some other host or port, you can pass the flags `--host` and `--port` with apt parameters.
You can also get all available parameters by firing
```sh
$ dicedb-cli --help
```
## Firing commands
You can execute any DiceDB command directly:
```bash
localhost:7379> SET k1 v1
OK OK
localhost:7379> GET k1
OK "v1"
localhost:7379> DEL k1
OK 1
```
You can find all available commands at [dicedb.io/docs](https://dicedb.io/docs).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.