Metadata-Version: 2.5
Name: tclake-cli
Version: 0.0.1
Summary: Command-line tool for Tencent Cloud TCLake
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# tclake-cli

Query TCLake metadata from the terminal via the `tccatalog` cloud API.
No third-party runtime dependencies; only the Python standard library is used.

## Install

```text
python3 -m pip install --user tclake-cli
```

Make sure the user install directory is on `PATH` (usually `~/.local/bin`).

## Quick start

```text
tclake init

tclake lakehouse list
tclake lakehouse list sales
tclake lakehouse list sales.db1
tclake lakehouse describe sales.db1.orders

tclake volume list
tclake volume list volc.db1
tclake volume describe volc.db1.raw
tclake volume credentials volc.db1.raw
```

`list` shows the next level below the path, `describe` shows the path itself.
`-o json` (also `--output json`, before or after the subcommand) prints the
full API response for scripting. `volume credentials` prints the temporary
keys in clear text by design.

## Credentials

`tclake init` writes `~/.tclake/config` (region, endpoint) and
`~/.tclake/credentials` (SecretId, SecretKey), both `0600`.
Environment variables override files:

```text
TENCENTCLOUD_SECRET_ID / TENCENTCLOUD_SECRET_KEY
TENCENTCLOUD_TOKEN (optional, temporary credentials)
TENCENTCLOUD_REGION / TENCENTCLOUD_ENDPOINT
```
