2 min read
Introduction
Knowns is a CLI-first knowledge management tool that gives AI persistent memory of your project context. Document once, link everywhere.
Why Knowns?
Modern development involves juggling tasks, documentation, and context across multiple tools. Knowns brings everything together in a simple, git-friendly format that works seamlessly with AI assistants.
Key Benefits
- CLI-First: Everything accessible from your terminal
- AI-Ready: Automatic context loading via
@doc/...and@task-...references - Git-Friendly: All data stored as Markdown in
.knowns/folder - Zero Lock-in: Plain text files you can read and edit anywhere
Quick Start
# Install globally
npm install -g knowns
# Initialize in your project
cd your-project
knowns init
# Create your first task
knowns task create "Setup project" -d "Initial setup" --ac "Dependencies installed"
# Open browser UI
knowns browserCore Concepts
Tasks
Tasks are the primary work items in Knowns. Each task has:
- Title: Clear summary of what needs to be done
- Description: Context and requirements
- Acceptance Criteria: Testable outcomes
- Status: todo, in-progress, in-review, blocked, done
Documentation
Documentation lives in .knowns/docs/ as Markdown files with frontmatter. Reference docs anywhere using the @doc/path syntax.
Time Tracking
Built-in timers let you track time spent on tasks. Generate reports by date range, label, or project.
Next Steps
- Installation Guide - Detailed setup instructions
- Task Management - Learn about task workflows
- Documentation - Managing project docs
- CLI Reference - Complete command reference