Skip to main content

Dind-CLI Documentation

Dind-CLI is a command-line interface (CLI) for managing nearly all aspects of the Dind.io platform. This tool enables you to handle services, resources, and other operations directly from your terminal. With it, you can create, start, stop, restart, and manage various components and configurations on Dind.io without needing to access the web interface. For detailed usage and command options, refer to the documentation.

Installation​

Windows​

You can install Dind-CLI using the following command:

irm https://cli.dind.io/install.ps1 | iex

Alternatively, you can use Chocolatey:

choco install dind-cli

Linux​

For Linux users, you can use the following script to install Dind-CLI:

curl -fsSL https://cli.dind.io/install.sh | sh

You can also install it using Snap:

sudo snap install dind-cli

macOS​

For macOS, use the following script to install Dind-CLI:

curl -fsSL https://cli.dind.io/install.sh | sh

Usage​

dind-cli [command]

Available Commands​

  • completion: Generate the autocompletion script for the specified shell.
  • help: Help about any command.
  • login: Log in to Dind.io and obtain an authentication token.
  • logout: Log out from Dind.io and clear the saved token.
  • rm: Remove one or more services by their names.
  • service: Manage services.
  • terms: Read the Terms and Conditions specified on the Dind.io platform.
  • version: Display the current version of DIND-CLI.

Flags​

  • -h, --help: help for dind-cli

Use "dind-cli [command] --help" for more information about a command.

Examples​

Get Dind-CLI Version​

$ dind-cli version
Dind-CLI version 1.0.0

Login to Dind.io​

You will be prompted to enter your email and password. If successful, you’ll receive a confirmation:

$ dind-cli login
Email: [email protected]
Password:
Successfully logged in. The authentication token has been saved.

Service Management Commands​

Service Help​

$ dind-cli service --help
Use the 'service' command to manage and perform various operations on services within Dind.io.

Usage:
  dind-cli service [command]

Available Commands:
  create      Create a new service of the specified type.
  list-all    List all available services.
  logs        Fetch and display the logs of a specified service by name.
  ls          List all created services.
  reset       Reset one or more services to their initial state by their names.
  restart     Restart one or more services by their names, stopping and starting them again.
  rm          Remove one or more services by their names.
  start       Start one or more stopped services by their names.
  stop        Stop one or more running services by their names.

Flags:
  -h, --help   help for service

Use "dind-cli service [command] --help" for more information about a command.

List All Services​

$ dind-cli service list-all
Available services:
Adminer, Consul, CouchDB, Dbeaver, Dependency-Track, Docker, Docker-Swarm, InfluxDB, Jenkins, Kafka, MariaDB, MinIO, MongoDB, MySQL, Neo4j, PgAdmin, Portainer, PostgreSQL, RabbitMQ, Redis, SSH-Tunneling, SonarQube, Tomcat, Vault, Wordpress

Create a New Service​

$ dind-cli service create MinIO
Creating service with name: MinIO
The new service has been created successfully!
Location: https://NxII4IJ8Uq.dind.io
Username: KqfRRHnyWj
Password: QhtNIM2YjDcQR7N0

List Created Services​

$ dind-cli service ls
Total services: 2
NAME        |IS ALIVE  |TYPE    |LOCATION                    |PORT   |LIFETIME (hours)   |DUE DATE
----        |--------  |----    |--------                    |----   |-----------------  |--------
3hmF4Vee1e  |true      |Consul  |https://3hmf4vee1e.dind.io  |22452  |12.0               |2024-11-16 20:34
MXbCoOzC21  |true      |Redis   |connect.dind.io             |43293  |12.0               |2024-11-16 18:54

Fetch Service Logs​

$ dind-cli service logs 3hmF4Vee1e
Service Logs for '3hmF4Vee1e':
2024-10-16T20:34:09.699Z [INFO]  agent.leader: started routine: routine="CA root expiration metric"
2024-10-16T20:34:09.699Z [INFO]  agent.leader: started routine: routine="CA signing expiration metric"
2024-10-16T20:34:09.699Z [INFO]  agent.leader: started routine: routine="virtual IP version check"
2024-10-16T20:34:09.699Z [INFO]  agent.leader: started routine: routine="config entry controllers"
2024-10-16T20:34:09.703Z [INFO]  agent.server: member joined, marking health alive: member=3hmF4Vee1e partition=default
2024-10-16T20:34:09.717Z [INFO]  agent.leader: stopping routine: routine="virtual IP version check"
2024-10-16T20:34:09.717Z [INFO]  agent.leader: stopped routine: routine="virtual IP version check"
2024-10-16T20:34:09.949Z [INFO]  agent.server: federation state anti-entropy synced
2024-10-16T20:34:12.210Z [ERROR] agent.anti_entropy: failed to sync remote state: error="ACL not found"
2024-10-16T20:34:12.730Z [ERROR] agent.anti_entropy: failed to sync remote state: error="ACL not found"
2024-10-16T20:34:20.177Z [ERROR] agent: Coordinate update error: error="ACL not found"
2024-10-16T20:34:34.106Z [INFO]  agent: Newer Consul version available: new_version=1.19.2 current_version=1.15.4
2024-10-16T20:34:34.338Z [ERROR] agent.anti_entropy: failed to sync remote state: error="ACL not found"
2024-10-16T20:34:35.537Z [ERROR] agent: Coordinate update error: error="ACL not found"

Reset a Service​

$ dind-cli service reset 3hmF4Vee1e
Resetting service: 3hmF4Vee1e
The service '3hmF4Vee1e' has been reset successfully!

Restart a Service​

$ dind-cli service restart 3hmF4Vee1e
Restarting service: 3hmF4Vee1e
The service '3hmF4Vee1e' has been restarted successfully!

Stop a Service​

$ dind-cli service stop 3hmF4Vee1e
Stopping service: 3hmF4Vee1e
The service '3hmF4Vee1e' has been stopped successfully!

Start a Stopped Service​

$ dind-cli service start 3hmF4Vee1e
Starting service: 3hmF4Vee1e
The service '3hmF4Vee1e' has been started successfully!

Remove Services​

$ dind-cli service rm 3hmF4Vee1e MXbCoOzC21
Deleting service: 3hmF4Vee1e
The service '3hmF4Vee1e' has been deleted successfully!
Deleting service: MXbCoOzC21
The service 'MXbCoOzC21' has been deleted successfully!

Logout from Dind.io​

$ dind-cli logout
Successfully logged out. The authentication token has been removed.

This document provides a comprehensive guide to using Dind-CLI for managing services and other resources on Dind.io. For more information, explore the specific command sections using dind-cli [command] --help.