chore: update README.md with new cli name
This commit is contained in:
38
README.md
38
README.md
@@ -1,4 +1,4 @@
|
||||
# Todo
|
||||
# todo-mcp
|
||||
|
||||
A todo CLI with a built-in [MCP](https://modelcontextprotocol.io/) server.
|
||||
The main idea is that you can tell an MCP-compatible AI assistant "add this to
|
||||
@@ -23,55 +23,55 @@ Set `TODO_DB` to override the default database path (`~/.local/share/todo/todos.
|
||||
|
||||
```sh
|
||||
# add a todo
|
||||
todo add "fix the login bug"
|
||||
todo-mcp add "fix the login bug"
|
||||
|
||||
# add with priority and tags
|
||||
todo add "refactor auth module" -p high -t backend -t tech-debt
|
||||
todo-mcp add "refactor auth module" -p high -t backend -t tech-debt
|
||||
|
||||
# add without associating to the current git repo
|
||||
todo add "something general" --no-project
|
||||
todo-mcp add "something general" --no-project
|
||||
|
||||
# list open todos
|
||||
todo ls
|
||||
todo-mcp ls
|
||||
|
||||
# list todos for the current repo only
|
||||
todo ls --here
|
||||
todo-mcp ls --here
|
||||
|
||||
# filter by tag or priority
|
||||
todo ls -t backend
|
||||
todo ls -p critical
|
||||
todo-mcp ls -t backend
|
||||
todo-mcp ls -p critical
|
||||
|
||||
# search
|
||||
todo ls -s "auth"
|
||||
todo-mcp ls -s "auth"
|
||||
|
||||
# mark as done
|
||||
todo done 3
|
||||
todo-mcp done 3
|
||||
|
||||
# edit text, priority, or tags
|
||||
todo edit 3 "updated description"
|
||||
todo edit 3 -p low
|
||||
todo edit 3 -t new-tag --untag old-tag
|
||||
todo-mcp edit 3 "updated description"
|
||||
todo-mcp edit 3 -p low
|
||||
todo-mcp edit 3 -t new-tag --untag old-tag
|
||||
|
||||
# remove permanently
|
||||
todo rm 3
|
||||
todo-mcp rm 3
|
||||
|
||||
# show all tags in use
|
||||
todo tags
|
||||
todo-mcp tags
|
||||
|
||||
# clean up completed todos
|
||||
todo purge
|
||||
todo-mcp purge
|
||||
```
|
||||
|
||||
## Claude Setup
|
||||
|
||||
Todo ships with an MCP server that lets Claude manage your todos. Add this to
|
||||
your Claude MCP config:
|
||||
todo-mcp ships with an MCP server that lets Claude manage your todos. Add this
|
||||
to your Claude MCP config:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"todo": {
|
||||
"command": "todo",
|
||||
"command": "todo-mcp",
|
||||
"args": ["mcp-serve"]
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user