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