0
0
mirror of https://github.com/crazy-max/diun.git synced 2024-11-24 16:06:46 +00:00
crazy-max_diun/docs/usage/command-line.md
2022-12-29 07:52:05 +01:00

3.7 KiB

Command Line

Usage

diun [global options] command [command or global options] [arguments...]

Global options

All global options can be placed at the command level.

  • --help, -h: Show context-sensitive help.
  • --version: Show version and exit.

Commands

serve

Starts Diun server.

  • --config <path>: Diun configuration file
  • --profiler-path <path>: Base path where profiling files are written
  • --profiler <string>: Profiler to use
  • --log-level <string>: Set log level (default info)
  • --log-json: Enable JSON logging output
  • --log-caller: Add file:line of the caller to log output
  • --log-nocolor: Disables the colorized output
  • --grpc-authority <string>: Address used to expose the gRPC server (default :42286)

Examples:

diun serve --config diun.yml --log-level debug

Following environment variables can also be used in place:

Name Default Description
CONFIG Diun configuration file
PROFILER_PATH Base path where profiling files are written
PROFILER Profiler to use
LOG_LEVEL info One of panic, fatal, error, warn, info, debug or trace
LOG_JSON false Enable JSON logging output
LOG_CALLER false Enable to add file:line of the caller
LOG_NOCOLOR false Disables the colorized output
GRPC_AUTHORITY :42286 Address used to expose the gRPC server

image list

!!! note Diun needs to be started through serve command to be able to use this command.

List images in database.

  • --raw: JSON output
  • --grpc-authority <string>: Link to Diun gRPC API (default 127.0.0.1:42286)

Examples:

diun image list
diun image list --raw

image inspect

!!! note Diun needs to be started through serve command to be able to use this command.

Display information of an image in database.

  • --image: Image to inspect (required)
  • --raw: JSON output
  • --grpc-authority <string>: Link to Diun gRPC API (default 127.0.0.1:42286)

Examples:

diun image inspect --image alpine
diun image inspect --image drone/drone --raw

image remove

!!! note Diun needs to be started through serve command to be able to use this command.

Remove an image manifest from database.

  • --image: Image to remove (required)
  • --grpc-authority <string>: Link to Diun gRPC API (default 127.0.0.1:42286)

Examples:

diun image remove --image alpine:latest
diun image inspect --image drone/drone

!!! warning All manifest for an image will be removed if no tag is specified

image prune

!!! note Diun needs to be started through serve command to be able to use this command.

Remove all manifests from the database.

  • --force: Do not prompt for confirmation
  • --grpc-authority <string>: Link to Diun gRPC API (default 127.0.0.1:42286)

Examples:

diun image prune

notif test

!!! note Diun needs to be started through serve command to be able to use this command.

Test notification settings.

  • --grpc-authority <string>: Link to Diun gRPC API (default 127.0.0.1:42286)

Examples:

diun notif test