Metadata-Version: 2.1
Name: cobo-cli
Version: 0.0.8
Summary: Cobo Command-line Tool
License: MIT
Author: Cobo
Author-email: support@cobo.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: dataclasses-json (>=0.6.7,<0.7.0)
Requires-Dist: email-validator (>=2.2.0,<3.0.0)
Requires-Dist: gitpython (>=3.1.43,<4.0.0)
Requires-Dist: pydantic (>=2.9.2,<3.0.0)
Requires-Dist: pydantic-settings (>=2.6.1,<3.0.0)
Requires-Dist: pynacl (>=1.5.0,<2.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: tomli (>=2.0.2,<3.0.0)
Requires-Dist: tomli-w (>=1.1.0,<2.0.0)
Requires-Dist: websocket-client (>=1.8.0,<2.0.0)
Description-Content-Type: text/markdown

# Cobo CLI

Cobo Command Line Interface (CLI) is a powerful developer tool designed to help you build, test, and manage your integration with [Cobo Wallet-as-a-Service (WaaS) 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction) directly from the command line.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Development](#development)
- [License](#license)

## Installation

To install Cobo CLI, you can use `pip` with the following command:

```bash
pip install cobo-cli
```

Ensure that you have Python 3.9 or newer installed.

Or you can install Cobo CLI via homebrew:

```bash
brew install cobo-cli
```

## Usage

To use Cobo CLI, run the following command in your terminal:

```bash
cobo [OPTIONS] COMMAND [ARGS]...
```

Check full documentation [here](https://www.cobo.com/developers/v2/developer-tools/cobo-cli/introduction).

### Global Options

- `-e, --env [dev|prod]`: Override the environment for this command.
- `-a, --auth [apikey|user|org]`: Override the authentication method for this command.
- `--enable-debug`: Enable debug mode for verbose logging.
- `--config-file FILEPATH`: Specify the path to the config file.
- `--spec PATH`: Path to a custom OpenAPI specification file.
- `--help`: Show help message and exit.

## Commands

### Application Management

- **app**: Manage Cobo applications.
  - `init`: Create a new Cobo application project.
  - `run`: Run a Cobo application.
  - `upload`: Upload a Cobo application.
  - `update`: Update an existing Cobo application.
  - `status`: Check the status of a Cobo application.

### Authentication

- **auth**: Set or view the default authentication method.

### Configuration

- **config**: Manage CLI configuration settings.
  - `set`: Set a configuration value.
  - `get`: Get a configuration value.
  - `list`: List all configuration values.
  - `delete`: Delete a configuration value.
  - `show-path`: Show the configuration file path.

### Login and Logout

- **login**: Perform user or organization login operations.
  - `status`: Show the current login status.
  - `switch-org`: Switch between logged-in organizations.
- **logout**: Perform user or organization logout operations.

### API Requests

- **get**: Make a GET request to a Cobo API endpoint.
- **post**: Make a POST request to a Cobo API endpoint.
- **put**: Make a PUT request to a Cobo API endpoint.
- **delete**: Make a DELETE request to a Cobo API endpoint.
- **graphql**: Execute a GraphQL query against the Cobo API.

### Documentation

- **doc**: Open Cobo documentation or display API operation information.

### Environment

- **env**: Set or view the current environment.

### Logs

- **logs**: Commands related to log operations.
  - `tail`: Tail the request logs from Cobo.

### Webhook

- **webhook**: Commands related to webhook operations.
  - `events`: List all available webhook event types.
  - `listen`: Listen for webhook events using WebSocket.
  - `trigger`: Manually trigger a webhook event.

### Other Commands

- **open**: Open a specific Cobo portal page in the default web browser.
- **keys**: Generate and manage API/APP keys.
  - `generate`: Generate a new API/APP key pair.
- **version**: Display the current version of the Cobo CLI tool.

## Development

You can build your custom Cobo CLI based on the [Cobo CLI](https://github.com/CoboGlobal/cobo-cli) project.
You need to install [Poetry](https://python-poetry.org/docs/#installation) first.

To set up the development environment, install the development dependencies:

```bash
poetry install
```

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

