A simple Kanban board for the terminal.

kanban

Find a file

Dan Anglin c1bb834a7f All checks were successful / test (pull_request) Successful in 34s Details / lint (pull_request) Successful in 46s Details feat(ui): add support for creating status columns This commit adds support for creating new status columns. When the user is in the 'board edit' mode, they can press the 'c' key to create a new column. When a new column is created it automatically assumes the last position on the board. We will add support later on to allow the user to re-arrange the columns on the board. Part of apollo/pelican#22		2024-01-17 17:10:36 +00:00
.forgejo/workflows	chore: project maintenance	2023-12-12 10:05:25 +00:00
cmd/pelican	refactor: a lil bit of refactoring	2024-01-14 13:46:42 +00:00
internal	feat(ui): add support for creating status columns	2024-01-17 17:10:36 +00:00
magefiles	refactor: a lil bit of refactoring	2024-01-14 13:46:42 +00:00
test/databases	feat: add the pelican project	2023-05-06 12:49:40 +01:00
.gitignore	refactor: a lil bit of refactoring	2024-01-14 13:46:42 +00:00
.golangci.yaml	feat(ui): add support for editing cards	2024-01-10 18:21:14 +00:00
go.mod	chore: project maintenance	2023-12-12 10:05:25 +00:00
go.sum	chore: project maintenance	2023-12-12 10:05:25 +00:00
LICENSE	chore: update LICENSE	2024-01-12 15:29:02 +00:00
README.asciidoc	feat(ui): display the number of cards in a status.	2024-01-12 16:00:17 +00:00

README.asciidoc

Pelican

Contents

Overview
Installation
Running Pelican
Keybindings
Inspiration

Overview

This project is in ALPHA state and is not ready for production use yet.

Pelican is a simple Kanban board for your terminal. Data is stored in a BoltDB database. Pelican does not make any assumptions to the path of the database file; instead the user is expected to specify the path when running the application.

Installation

Requirements

Go

A minimum version of Go 1.21.0 is required for installing spruce. Please go here to download the latest version.

Mage (Optional)

The project includes a magefile for automating the build and installation of the binary. You can visit the website for instructions on how to install Mage.

Install with Mage

You can install pelican with Mage using the following commands:

git clone https://codeflow.dananglin.me.uk/apollo/pelican.git
cd pelican
mage install

The default install prefix is set to /usr/local so pelican will be installed to /usr/local/bin/pelican. If you want to change the install prefix you can set the PELICAN_INSTALL_PREFIX environment variable before installing.

PELICAN_INSTALL_PREFIX=~/.local mage install

Install with Go

If your GOBIN directory is included in your PATH then you can install Pelican with Go.

git clone https://codeflow.dananglin.me.uk/apollo/pelican.git
cd pelican
go install ./cmd/pelican

Running Pelican

To create a new Kanban project with Pelican, simply run the following command:

pelican project.pelican

This will create a new BoltDB database file called project.pelican in your current directory and initialises the database with an empty project.

Keybindings

Key	Action
`CTRL + q`	Quit the application
`c`	Create a new card
`CTRL + d`	Delete a card
`m`	Move a card from one column to another (press `Enter` to confirm your selection).
`Enter`	View the details of a card (press `ESC` to go back to the main board).

Inspiration

The toukan project