wekan-cli 2.1.0

Agent-first, human-friendly command-line client for Wekan
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# Swimlanes

The singular `wekan swimlane` family covers core swimlane operations plus
native copying, moving, and repositioning. See [copy and move](copy-and-move.md)
for transfer syntax and acknowledgments. Use `card list --board <BOARD_ID>
--swimlane <SWIMLANE_ID>` to list cards in a swimlane.

## Commands

```console
wekan swimlane list --board <BOARD_ID>
wekan swimlane get <SWIMLANE_ID> --board <BOARD_ID>
wekan swimlane create --board <BOARD_ID> --title <TITLE> [--sort <NUMBER>]
wekan swimlane update <SWIMLANE_ID> --board <BOARD_ID> --title <TITLE>
wekan swimlane delete <SWIMLANE_ID> --board <BOARD_ID> [--yes]
```

Titles and identifiers are trimmed and must not be empty. `--sort` accepts any
finite JSON number, including negative and fractional values. When omitted,
Wekan appends the new swimlane after the existing swimlanes.

Use `--output json` for stable machine-readable envelopes. A collection result
has the shape:

```json
{
  "ok": true,
  "data": {
    "board_id": "board-id",
    "swimlanes": [
      {
        "swimlane_id": "swimlane-id",
        "title": "Delivery"
      }
    ]
  }
}
```

`swimlane get` maps the complete supported Wekan v12.57 document to
snake-case output. Wekan's `_id` becomes `swimlane_id` and `type` becomes
`swimlane_type`. Optional archive/update dates, sort, color and height are
present as their value or JSON `null`. Dates, colors, Wekan's `-1` or
50-through-2000 height constraint, and required nonempty identifiers are
validated. Invalid known values or unmodeled fields cause `protocol_error`.

Creation returns `{"board_id":"...","swimlane_id":"..."}`.
An update reports the one supported field explicitly:

```json
{
  "ok": true,
  "data": {
    "board_id": "board-id",
    "swimlane_id": "swimlane-id",
    "updated_fields": ["title"]
  }
}
```

## Hard deletion

Wekan v12.57 physically removes the swimlane. When fewer than two matching live
lists exist, its removal hook physically removes those lists and their cards;
otherwise it removes cards assigned to the swimlane and leaves the lists.
Because those effects are destructive, `swimlane delete` requires interactive
confirmation or command-local `--yes`.

The endpoint is idempotent: deleting an absent swimlane still returns the
requested ID. Therefore `deletion_requested: true` and `delete_mode: "hard"` mean Wekan
accepted and validated the request, not that a live swimlane necessarily
existed immediately before the call. Delete data includes `board_id` and
`swimlane_id`. Declining deletion returns the shared cancellation result with
operation `swimlane_delete`. A subsequent `swimlane get` normalizes
Wekan's empty HTTP 200 response to the stable `not_found` error.

Copy/move command syntax, position inputs, typed acknowledgments, and pinned
server behavior are documented in [copy and move](copy-and-move.md).