Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ jobs:

- name: Install MkDocs and theme
run: |
pip install mkdocs-material
pip install 'mkdocs-material==9.*'

- name: Test documentation build
run: mkdocs build --strict --site-dir _test_site
4 changes: 2 additions & 2 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
branches:
- main
paths:
- 'docs/**'
- 'docs/site/**'
- 'mkdocs.yml'
- '.github/workflows/deploy-docs.yml'
workflow_dispatch:
Expand Down Expand Up @@ -33,7 +33,7 @@ jobs:

- name: Install MkDocs and theme
run: |
pip install mkdocs-material
pip install 'mkdocs-material==9.*'

- name: Build documentation
run: mkdocs build --strict --site-dir _site
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,17 @@ A GitHub CLI-inspired command-line interface for ClickUp.
brew install timimsms/cu/cu
```

Installs from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap. Available with the first tagged release.
Installs the latest tagged release from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap.

### Go
```bash
go install github.com/timimsms/cu/cmd/cu@latest
```

Note: binaries installed via `go install` currently report `dev` from `cu version` ([#36](https://github.com/timimsms/cu/issues/36)); Homebrew and release downloads embed the real version.

### npm
Planned as `@timimsms/cu` (not yet published).
The package name `@timimsms/cu` is reserved on npm as a placeholder only — a functional package is not yet published. Use Homebrew, `go install`, or a release download instead.

### Direct Download
Download the latest release from the [releases page](https://github.com/timimsms/cu/releases).
Expand Down
2 changes: 1 addition & 1 deletion docs/site/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Tokens are never written to disk in plaintext by `cu` — there is no plaintext

## Headless Linux Caveat

On headless Linux (servers, containers, CI), `cu` requires a running Secret Service implementation to store and read the token. There is currently no environment-variable fallback, so authentication will fail without one. A common workaround is to run a keyring daemon such as `gnome-keyring-daemon` with a D-Bus session.
On headless Linux (servers, containers, CI), `cu` requires a running Secret Service implementation to store and read the token. There is currently no environment-variable fallback, so authentication will fail without one. A common workaround is to run a keyring daemon such as `gnome-keyring-daemon` with a D-Bus session. An environment-variable token fallback is planned — see [issue #26](https://github.com/timimsms/cu/issues/26).

## Revoking Access

Expand Down
6 changes: 4 additions & 2 deletions docs/site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,19 @@ A GitHub CLI-inspired command-line interface for ClickUp.
brew install timimsms/cu/cu
```

Installs from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap. Available with the first tagged release.
Installs the latest tagged release from the [timimsms/homebrew-cu](https://github.com/timimsms/homebrew-cu) tap.

### Go

```bash
go install github.com/timimsms/cu/cmd/cu@latest
```

Note: binaries installed via `go install` currently report `dev` from `cu version` ([#36](https://github.com/timimsms/cu/issues/36)); Homebrew and release downloads embed the real version.

### npm

Planned as `@timimsms/cu` (not yet published).
The package name `@timimsms/cu` is reserved on npm as a placeholder only — a functional package is not yet published. Use Homebrew, `go install`, or a release download instead.

### Direct Download

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ theme:
- search.highlight
- content.tabs.link
- content.code.copy
- content.action.edit

nav:
- Home: index.md
Expand Down
Loading