kanri 0.8.1

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
78
79
80
81

# 🗂️ Kanri


![Crates.io Version](https://img.shields.io/crates/v/kanri) ![GitHub branch check runs](https://img.shields.io/github/check-runs/kostya-zero/kanri/main)

Yet another manager for your projects.

Kanri is a command-line tool designed for managing your projects.
It offers a simple and user-friendly interface for managing your projects using CLI.
Kanri is available for Windows, Linux, and macOS (compatibility with *BSD systems is not guaranteed).

> [!NOTE]
> This project is in beta. Some changes in newer version may not be backward compatible with previous versions and may require actions from user for an update.

## Installation


You can install Kanri with [Cargo](https://doc.rust-lang.org/cargo/) using the following commands:

```shell
# Compile and install Kanri.

cargo install kanri

# Install precompiled binaries (requires cargo-binstall).

cargo binstall kanri
```

You can also install Kanri from [GitHub Releases](https://github.com/kostya-zero/kanri/releases). If you prefer to build Kanri from source, please refer to the [Building Kanri](docs/BUILDING.md) guide.

## Usage


Before using Kanri, configure it according to your workspace setup. Detailed configuration options are available in the [Configuration Manual](docs/CONFIGURATION.md).

### List Projects


Kanri simplifies project management. To view a list of your projects, use the `list` subcommand:

```shell
kanri list
```

> [!NOTE]
> By default, Kanri hides projects whose names start with a dot (e.g., `.hidden_project`). You can change this behavior by configuring the `display_hidden` parameter as described in the [Configuration Manual](docs/CONFIGURATION.md).

### Managing Projects


Creating and removing projects with Kanri is straightforward:

```shell
# Create a new project.

kanri new bookshelf

# Remove an existing project.

kanri remove bookshelf
```

### Working with Projects


Open project directly in your configured editor or shell using the `open` subcommand:

```shell
# Open the project in your editor.

kanri open bookshelf

# Open the project in your shell.

kanri open bookshelf --shell
```

### Quick Help


For assistance with commands, use the `--help` flag:

```shell
# General help.

kanri --help

# Help for a specific subcommand.

kanri config --help
```

## License


This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.