kanri 0.11.0

Manage your projects within the terminal.
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

# Profiles


Kanri profiles let you switch editor and shell settings without rewriting your configuration. The active profile is selected by `options.current_profile` in `config.toml`.

Profiles affect commands that launch external programs, especially:

- `kanri open <project>`
- `kanri open <project> --shell`
- `kanri config edit`
- `kanri blueprints new <name>` when Kanri opens the new blueprint in your editor
- `kanri blueprints edit <name>` when Kanri opens an existing blueprint in your editor

## Profile structure


Profiles live under the `[profiles]` table in the configuration file:

```toml
[profiles.default]
editor = "code"
editor_args = ["."]
editor_fork_mode = true
shell = "bash"
```

Each profile has these fields:

- `editor` - Program used for editor sessions.
- `editor_args` - Extra arguments passed to the editor. Code-family editors usually use `["."]` so the project directory opens as a workspace.
- `editor_fork_mode` - If `true`, Kanri starts the editor and returns immediately instead of waiting for it to exit.
- `shell` - Program used for shell sessions.

Unknown profile fields are rejected when the configuration is loaded.

> [!NOTE]
> Older Kanri versions used `shell_args`. Current Kanri no longer supports that field and can migrate it out of existing configuration files.

## Default profile


Kanri creates a `default` profile on first run. It detects a default editor from `VISUAL` or `EDITOR`, and a default shell from `SHELL` or `COMSPEC` on Windows.

For Code-family editors such as `code`, `code-insiders`, `codium`, `code-oss`, `cursor`, and `windsurf`, Kanri enables fork mode and adds `.` to `editor_args`. On Windows, Kanri also appends `.cmd` where needed.

## Managing profiles from the CLI


```shell
# Create a profile interactively.

kanri profiles new

# List profiles. The current profile is marked.

kanri profiles list

# Show profile details.

kanri profiles get default

# Set active profile.

kanri profiles set default

# Remove a profile with confirmation.

kanri profiles remove old-profile

# Remove without prompting.

kanri profiles remove old-profile --yes
```

Kanri prevents removing the current active profile. Switch to another profile first with `kanri profiles set <name>`.

## Opening projects with profiles


```shell
# Uses the current profile's editor, editor_args, and editor_fork_mode.

kanri open my-project

# Uses the current profile's shell.

kanri open my-project --shell
```

Shell sessions receive `KANRI_SESSION=1` in their environment.