Skip to content

Commit babf07d

Browse files
committed
docs: document Todoist OAuth auth setup
Clarify the default Comms OAuth grant and the supported non-production OAuth hosts.
1 parent 7e41aa3 commit babf07d

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ This makes the `tdc` command available globally.
6464
tdc auth login
6565
```
6666

67-
This opens your browser to authenticate with Comms. Once approved, the token is stored in your OS credential manager:
67+
This opens Todoist OAuth in your browser. The default grant can read Comms data and create/update content and messages. It does not include delete, channel management, or user/workspace write scopes; use `--read-only` for read-only access or `--full-access` when needed.
68+
69+
Once approved, the token is stored in your OS credential manager:
6870

6971
- macOS: Keychain
7072
- Windows: Credential Manager
@@ -96,11 +98,11 @@ Point the CLI at a non-production Comms instance with `COMMS_BASE_URL`:
9698

9799
```bash
98100
export COMMS_BASE_URL=https://comms.staging.todoist.com
99-
export COMMS_API_TOKEN=<staging-token>
101+
tdc auth login
100102
tdc user
101103
```
102104

103-
The base URL is threaded through both the SDK and the search endpoint. You need a token issued by that environment — production tokens are rejected.
105+
The base URL is used for OAuth, the SDK, and search. OAuth login supports `comms.todoist.com`, `comms.staging.todoist.com`, and `comms.local.todoist.com`; staging uses `https://staging.todoist.com` as the Todoist OAuth host. For custom Comms hosts, use `COMMS_API_TOKEN`.
104106

105107
### Auth commands
106108

0 commit comments

Comments
 (0)