DOB-CLI - User Guide

User Guide: DOB-CLI

The DOB-CLI enables users to manage and execute tasks on a DevOps-Bot host server remotely. To use the CLI, you need a **persona credential**, which is part of the RBAC (Role-Based Access Control) functionality.

Pre-requisites

Ensure the Following Are Installed:

• Git
• Python 3
• Pip (Python Package Installer)

Installation Steps

1. Update your package list:

apt-get update

2. Install Git:

apt install git

3. Install Pip:

apt install python3-pip

4. Clone the DOB-CLI repository:

git clone https://github.com/Devops-Bot-Official/dob-cli.git

5. Navigate to the repository folder:

cd dob-cli

6. Install the DOB-CLI package:

pip install dob_cli-0.1-py3-none-any.whl

7. Verify installation by running:

dob --help

Configuration Steps

To configure DOB-CLI, you need the following:

• A **persona name**
• A **persona token**
• A **private key file**
• The **host endpoint** of the DevOps-Bot server

Steps:

1. Create a private key file:

vim david_private.pem

Add your private key contents to the file and save.

2. Run the following command to configure the CLI:

dob config --persona-name david --token 827a89a7-8c36-416b-8e44-e7f78960618f --private-key-path david_private.pem --host-endpoint http://IP:4102
            

Replace the values with your own persona name, token, private key path, and host endpoint.

Testing the Configuration

Run a Sample Proxy Command:

To test the configuration, execute the following command:

dob run generate-webhook-secret

If configured correctly, you’ll see a confirmation message, and a webhook secret will be generated successfully.

Notes

• Ensure that your persona token is valid and has the required permissions.
• Keep your private key file secure and do not share it with anyone.
• If you face any issues, recheck the configuration command and ensure the host endpoint is accessible.