vlkcli 0.1.0

No project description provided

Valkyrie CLI

Overview

Valkyrie CLI is a command-line interface designed to interact with the Valkyrie API, providing functionality for user authentication, tool management, API key creation, wallet operations, and more. It supports executing individual commands and processing sequences of commands from a YAML configuration file.

---

Features

• Authentication: Login with username and password to obtain a session token.
• Tools Management: View all tools, fetch tool details, and execute specific tool endpoints.
• API Key Management: Create, list, and delete API keys associated with tools.
• Wallet Operations: Retrieve wallet details and transaction history.
• Batch Command Execution: Execute a sequence of commands defined in a YAML file.

---

Installation

1. Clone the repository:

   git clone [e-mail]:AzumoHQ/azumo-valkyrie-cli.git
   cd azumo-valkyrie-cli
   

2. Install the CLI using setup.py:

   python setup.py install
   

3. After installation, the vlk command will be available in your terminal.

---

Usage

Run the CLI using the vlk command:

vlk <command> [options]

Commands

Authentication

• Login:

  vlk login <username>
  

Tools

• List all tools:

  vlk tools
  

• Get tool details:

  vlk tools:info --tool <tool_id>
  

• Execute a tool endpoint:

  vlk tools:run --tool <tool_id> --endpoint <endpoint> --api-key <api_key> --payload <json_payload>
  

API Keys

• List API keys:

  vlk api-keys
  

• Create an API key:

  vlk api-keys:create --key-name <name> --tool <tool_id>
  

• Delete an API key:

  vlk api-keys:delete --api-key <api_key_id>
  

Wallet

• View wallet details:

  vlk wallet
  

• View wallet transactions:

  vlk wallet:transactions --type <CREDIT|DEBIT> --order <asc|desc> --page <page_num> --page_size <num>
  

Execute Configuration

• Run a sequence of commands from a YAML file:

  vlk execute-config --file <config.yaml>
  

---

Example YAML Configuration

- command: login
  args:
    username: [e-mail]

- command: tools
  args: {}

- command: tools:info
  args:
    tool: the-dog-api

- command: wallet
  args: {}

- command: wallet:transactions
  args:
    page_size: 2
    page: 2
    order: desc

Run the configuration:

vlk execute-config --file config.yaml

---

Authentication Token

After successful login, a token is saved in ~/.valkyrie_token for subsequent authenticated requests. Ensure to keep this file secure.