diff --git a/README.md b/README.md index 5e10b0d..d069a1b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ A command-line interface for [Tangled](https://tangled.sh), the decentralized Gi `tng` brings the full Tangled workflow to your terminal: authenticate with your AT Protocol identity, manage repositories, create and review pull requests, file and track issues -- all without leaving the command line. +## Known Issues + +- **Appview visibility**: Repos created via the CLI (or any non-web client) do not appear on tangled.sh/tangled.org. The appview's firehose ingester does not yet process `sh.tangled.repo` records. Repos are fully functional (push, pull, PRs, issues) but invisible on the web until this is resolved server-side. +- **PR/issue list scope**: `tng pr list` and `tng issue list` show only records authored by the authenticated user. The appview aggregates records from all authors but does not expose a public JSON API, so cross-user listing is not yet possible from the CLI. +- **OAuth session expiry**: The public client OAuth flow produces tokens that cannot always be refreshed silently. If you encounter `invalid_grant` errors, run `tng auth login` to re-authenticate. +- **Repo view on empty repos**: `tng repo view` returns a 404 for repos with no commits, since the knot has no ref to resolve. Push at least one commit first. + ## Installation ### From source @@ -15,8 +22,8 @@ go install knot.eric.wien/tng/cmd/tng@latest ### Build from source ```sh -git clone git@tangled.sh:eric.wien/tng -cd tng +git clone git@tangled.sh:eric.wien/tng-cli +cd tng-cli make build # Binary is at ./bin/tng ``` @@ -231,13 +238,6 @@ default_knot: "" # Default knot for repo creation api_host: "" # Override API host ``` -## Known Issues - -- **Appview visibility**: Repos created via the CLI (or any non-web client) do not appear on tangled.sh/tangled.org. The appview's firehose ingester does not yet process `sh.tangled.repo` records. Repos are fully functional (push, pull, PRs, issues) but invisible on the web until this is resolved server-side. -- **PR/issue list scope**: `tng pr list` and `tng issue list` show only records authored by the authenticated user. The appview aggregates records from all authors but does not expose a public JSON API, so cross-user listing is not yet possible from the CLI. -- **OAuth session expiry**: The public client OAuth flow produces tokens that cannot always be refreshed silently. If you encounter `invalid_grant` errors, run `tng auth login` to re-authenticate. -- **Repo view on empty repos**: `tng repo view` returns a 404 for repos with no commits, since the knot has no ref to resolve. Push at least one commit first. - ## Architecture `tng` follows the same architectural patterns as the [GitHub CLI](https://github.com/cli/cli):