mirror of
https://github.com/versia-pub/server.git
synced 2025-12-06 16:38:19 +01:00
e6c7e8a597
Some checks failed
CodeQL Scan / Analyze (javascript-typescript) (push) Failing after 5s
Build Docker Images / lint (push) Failing after 10s
Build Docker Images / check (push) Failing after 10s
Build Docker Images / tests (push) Failing after 6s
Build Docker Images / build (server, Dockerfile, ${{ github.repository_owner }}/server) (push) Has been skipped
Build Docker Images / build (worker, Worker.Dockerfile, ${{ github.repository_owner }}/worker) (push) Has been skipped
Deploy Docs to GitHub Pages / build (push) Failing after 5s
Deploy Docs to GitHub Pages / Deploy (push) Has been skipped
Mirror to Codeberg / Mirror (push) Failing after 0s
Nix Build / check (push) Failing after 5s
22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
# Versia Server CLI
|
|
|
|
Versia Server includes a built-in, scripting-compatible CLI that can be used to manage the server. This CLI can be used to create and delete users, manage the database and more. It can also output data in JSON or CSV format, making it easy to use in scripts.
|
|
|
|
## Using the CLI
|
|
|
|
Versia Server includes a built-in CLI for managing the server. To use it, simply run the following command:
|
|
|
|
```bash
|
|
# Docker
|
|
# Replace `versia` with the name of your container
|
|
docker compose exec -it versia /bin/sh /app/entrypoint.sh cli help
|
|
```
|
|
|
|
You can use the `help` command to see a list of available commands. These include creating users, deleting users and more. Each command also has a `--help,-h` flag that you can use to see more information about the command.
|
|
|
|
## Scripting with the CLI
|
|
|
|
Some CLI commands that return data as tables can be used in scripts. To convert them to JSON or CSV, some commands allow you to specify a `--format` flag that can be either `"json"` or `"csv"`. See `cli help` or `cli <command> -h` for more information.
|
|
|
|
Flags can be used in any order and anywhere in the script (except for the `cli` command itself).
|