Installation

How to install and configure Knowns CLI on your system

2 min read

Installation

Knowns requires Node.js 18 or higher. Install it globally using your preferred package manager.

Package Managers

npm

npm install -g knowns

yarn

yarn global add knowns

pnpm

pnpm add -g knowns

bun

bun install -g knowns

Verify Installation

After installation, verify that Knowns is available:

knowns --version

You should see the version number printed.

Initialize a Project

Navigate to your project directory and run:

cd your-project
knowns init

This creates a .knowns/ folder with the following structure:

.knowns/
├── config.json      # Project configuration
├── tasks/           # Task files
└── docs/            # Documentation files

Configuration

The config.json file contains project settings:

{
  "name": "your-project",
  "version": "1.0.0",
  "settings": {
    "defaultPriority": "medium",
    "taskPrefix": "TASK"
  }
}

Browser UI

Knowns includes a web-based UI for visual task management:

knowns browser

This opens a local server with:

  • Kanban board view
  • Document browser
  • Task details panel
  • Dark mode support

Updating

To update Knowns to the latest version:

npm update -g knowns

Uninstalling

To remove Knowns:

npm uninstall -g knowns

Note: This does not remove .knowns/ folders from your projects.