cgd 0.1.0-alpha.2

Official command-line interface for Coragrid source-linked private-market data infrastructure
Documentation
# `cgd`

`cgd` is the official open-source command-line and terminal user interface
for Coragrid's source-linked private-market data infrastructure.

> `cgd` is in early alpha. Coragrid API access is currently granted by request.
> Commands, configuration, and output may change before 1.0.

## Quickstart

Install the alpha from crates.io

```bash
cargo install cgd --version 0.1.0-alpha.2 --locked
```

Authenticate and launch the terminal interface:

```bash
cgd auth login
cgd
```

For automation, provide a scoped key through the environment:

```bash
export CORAGRID_API_KEY="<your-scoped-key>"
cgd auth status
```

Installing `cgd` does not grant Coragrid API access. Visit
[coragrid.com](https://coragrid.com) for access information.

## Usage

Run `cgd` in an interactive terminal to open the TUI. Press `F1` for its
controls, or use `cgd --help` to explore headless commands and output formats.

## Docs

- [Command reference]docs/command-reference.md
- [Automation examples]docs/automation-examples.md
- [Man pages]docs/man
- [Contributing]CONTRIBUTING.md
- [Security]SECURITY.md

## Building from source

`cgd` requires Rust 1.88 or newer.

```bash
git clone https://github.com/coragrid/cgd.git
cd cgd
cargo build --locked
```

Run the local checks with:

```bash
cargo fmt --check
cargo test --locked
cargo clippy --all-targets --locked -- -D warnings
```

## License

`cgd` is available under the [Apache License 2.0](LICENSE-APACHE) or the
[MIT License](LICENSE-MIT), at your option. These licenses cover the client
source code; access to Coragrid services and data is separate.