wekan-cli 0.5.0

Agent-first, human-friendly command-line client for Wekan
Documentation

Wekan CLI

Wekan CLI is an agent-first, human-friendly command-line client for Wekan. It provides deterministic commands, stable JSON output, explicit errors, native credential storage, and confirmation gates for destructive operations.

Version 0.5.0 targets Wekan v11.06 exactly. Other Wekan versions are not currently supported or tested.

Install

Rust 1.88 or newer can build the published crate:

cargo install wekan-cli --locked

GitHub Releases also provides checksummed archives for Windows x64, macOS Intel and Apple Silicon, and Linux x64 and ARM64. The release installers select the right archive and install wekan into Cargo's bin directory.

macOS and Linux:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/AhmedLukman/wekan-cli/releases/latest/download/wekan-cli-installer.sh | sh

Windows PowerShell:

powershell -ExecutionPolicy Bypass -c "irm https://github.com/AhmedLukman/wekan-cli/releases/latest/download/wekan-cli-installer.ps1 | iex"

The GitHub binaries are not signed with paid Apple or Windows publisher certificates, so Gatekeeper or SmartScreen may show an unknown-developer warning. Release assets include SHA-256 checksums and GitHub build provenance. With the GitHub CLI installed, an asset can be verified with:

gh attestation verify PATH-TO-ASSET -R AhmedLukman/wekan-cli

Quick start

Login can initialize the default profile after Wekan accepts the credentials:

wekan --server https://wekan.example/ auth login --username alice
wekan auth status
wekan board list

Use JSON output for scripts and agents:

wekan --output json board list

Scoped commands name their parent IDs explicitly:

wekan card get CARD_ID --board BOARD_ID --list LIST_ID
wekan comment list --board BOARD_ID --card CARD_ID

Passwords and optional two-factor codes are read without echo. Automation can use --password-stdin and --code-stdin; secrets are deliberately unsupported as command-line values or environment variables. Login tokens are stored in the operating system's native credential vault.

For a local or explicitly managed profile:

wekan profile add local http://localhost:3000 --use
wekan --profile local auth login --username alice

Command coverage

The CLI includes profile and authentication management plus typed commands for users, boards, lists, swimlanes, cards, comments, checklists, and checklist items. It implements 46 of the 143 operations in the corrected Wekan v11.06 contract, including dedicated card archive and card restore commands. Operations without a dedicated command remain available through the same-origin wekan api request escape hatch.

Run wekan --help or wekan <COMMAND> --help for the complete command syntax. Detailed behavior is documented in:

Development and security

See CONTRIBUTING.md for development checks and API contract rules. Report vulnerabilities privately as described in SECURITY.md.

Wekan CLI is licensed under the Apache License 2.0.