CLI harness for Vikunja task management
Project description
cli-anything-vikunja
中文 | English
Vikunja 的命令行客户端 —— 一款可自托管的待办事项应用。
从终端管理你的项目、任务、标签、团队等。同时面向人类用户和 AI 智能体自动化设计。
功能特性
- 完整 API 覆盖 — 项目、任务、标签、团队、评论、附件、Webhook、分享、通知、关联、回应、管理后台
- 单次命令 & 交互模式 — 使用单条命令或进入 REPL 交互模式
- JSON 输出 —
--json标志,方便脚本和智能体消费 - 零外部依赖 — 仅需
click(HTTP 请求使用标准库urllib) - 任务关联 — 子任务、阻塞、相关以及所有 Vikunja 关联类型
安装
pip install cli-anything-vikunja
从源码安装:
git clone https://github.com/theLastWinner/cli-anything-vikunja.git
cd cli-anything-vikunja
pip install -e .
快速开始
# 交互式登录
cli-anything-vikunja auth login
# 或使用 API Token
cli-anything-vikunja auth token --url https://vikunja.example.com YOUR_TOKEN
# 或使用环境变量
export VIKUNJA_API_URL=https://vikunja.example.com
export VIKUNJA_TOKEN=your-token
使用方法
项目管理
cli-anything-vikunja projects list
cli-anything-vikunja projects create --title "Sprint 42"
cli-anything-vikunja projects get 1
cli-anything-vikunja projects update 1 --description "Q2 冲刺"
cli-anything-vikunja projects delete 1
任务管理
cli-anything-vikunja tasks list
cli-anything-vikunja tasks list --project 1
cli-anything-vikunja tasks create --project 1 --title "修复认证 Bug" --priority 5
cli-anything-vikunja tasks done 42
cli-anything-vikunja tasks undone 42
cli-anything-vikunja tasks update 42 --title "新标题"
cli-anything-vikunja tasks delete 42
任务关联(子任务、阻塞等)
# 添加子任务
cli-anything-vikunja tasks relations add-subtask 10 20
# 标记任务 5 阻塞任务 8
cli-anything-vikunja tasks relations add-blocking 5 8
# 使用任意关联类型
cli-anything-vikunja tasks relations add 10 20 --kind subtask
# 移除关联
cli-anything-vikunja tasks relations remove 10 20 --kind subtask
支持的关联类型:subtask、parenttask、related、duplicateof、duplicates、blocking、blocked、precedes、follows、copiedfrom、copiedto
标签与团队
cli-anything-vikunja labels list
cli-anything-vikunja labels create --title "bug" --hex-color FF0000
cli-anything-vikunja teams list
cli-anything-vikunja teams create --name "后端团队"
评论与通知
cli-anything-vikunja comments list 42
cli-anything-vikunja comments add 42 --comment "看起来不错"
cli-anything-vikunja notifications list
cli-anything-vikunja notifications read-all
JSON 输出
cli-anything-vikunja --json tasks list --project 1
cli-anything-vikunja --json projects get 1
交互式 REPL
cli-anything-vikunja repl
命令速查
| 命令组 | 可用命令 |
|---|---|
auth |
login, logout, status, token |
projects |
list, get, create, update, delete, duplicate |
tasks |
list, get, create, update, done, undone, delete |
tasks relations |
add, remove, add-subtask, add-blocking, add-related |
labels |
list, create, update, delete |
teams |
list, create, update, delete, add-member, remove-member |
notifications |
list, read, read-all |
comments |
list, add, delete |
shares |
list, create, delete |
webhooks |
list, create, delete |
admin |
overview, users |
配置
配置文件存储在 ~/.config/cli-anything-vikunja/config.json。
| 环境变量 | 说明 |
|---|---|
VIKUNJA_API_URL |
Vikunja API 基础 URL |
VIKUNJA_TOKEN |
JWT 或 API Token |
开发指南
pip install -e ".[dev]"
pytest -v
许可证
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cli_anything_vikunja-0.1.0.tar.gz.
File metadata
- Download URL: cli_anything_vikunja-0.1.0.tar.gz
- Upload date:
- Size: 20.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9316d5c7c9b058e0cbea6b5eaadcbe83b6bd396450fc250441ffe833878c8a38
|
|
| MD5 |
afb0e385139a0046902dd8afa5333392
|
|
| BLAKE2b-256 |
0ba4674989cfc428452e22692175852c36834e620b7076625122b31b33bbe2b2
|
File details
Details for the file cli_anything_vikunja-0.1.0-py3-none-any.whl.
File metadata
- Download URL: cli_anything_vikunja-0.1.0-py3-none-any.whl
- Upload date:
- Size: 15.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2af32a041be177711613644f7d3a32ed9c98db8bbdc996b7d50ce62d532f8b5c
|
|
| MD5 |
6c630a0772d916f211315326e1ded1ae
|
|
| BLAKE2b-256 |
02636b25357b133b7838ce8d05256563b06fe6293612e34204fa5f0acff2197d
|