Skip to content

docs: add Codex CLI instructions and clarify .env auto-loading #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seaniedan-flwls wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Codex CLI instructions and clarify .env auto-loading #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,16 @@ Use TickTick with AI assistants like Claude through the Model Context Protocol.

### Step 2: Get OAuth2 Access Token

Run the auth command with your credentials:
Create a `.env` file with your credentials (the CLI loads it automatically):

```bash
TICKTICK_CLIENT_ID=your_client_id
TICKTICK_CLIENT_SECRET=your_client_secret
```

Then run:

```bash
TICKTICK_CLIENT_ID=your_client_id \
TICKTICK_CLIENT_SECRET=your_client_secret \
ticktick-sdk auth
```

Expand Down Expand Up @@ -212,6 +217,25 @@ Add to your Claude Desktop config:
}
```

#### Codex CLI

```bash
codex mcp add ticktick \
--env TICKTICK_CLIENT_ID=your_client_id \
--env TICKTICK_CLIENT_SECRET=your_client_secret \
--env TICKTICK_ACCESS_TOKEN=your_access_token \
--env TICKTICK_USERNAME=your_email \
--env TICKTICK_PASSWORD=your_password \
-- ticktick-sdk
```

Verify it's working:

```bash
codex mcp list # See configured servers
codex # Start Codex - TickTick tools are now available
```

#### Other MCP-Compatible Tools

This server works with any tool that supports the Model Context Protocol, which includes most modern AI assistants and IDEs. The configuration is similar - you just need to provide the command (`ticktick-sdk`) and the environment variables shown above.
Expand Down