Configuration

Configure Knowns CLI for your project

2 min read

Configuration

Customize Knowns behavior with configuration options.

Project Configuration

Located at .knowns/config.json:

{
  "project": "my-project",
  "version": "1.0.0"
}

Options

Key	Type	Description
`project`	string	Project name
`version`	string	Config version

Project Structure

After knowns init, your project contains:

.knowns/
├── config.json       # Project configuration
├── tasks/            # Task markdown files
│   ├── task-1 - First Task.md
│   └── task-2 - Second Task.md
└── docs/             # Documentation
    ├── patterns/
    ├── architecture/
    └── guides/

Task Files

Each task is a markdown file with frontmatter:

---
id: "42"
title: "Add authentication"
status: "in-progress"
priority: "high"
assignee: "@john"
labels: ["feature", "auth"]
createdAt: "2025-01-15T10:00:00Z"
updatedAt: "2025-01-15T14:30:00Z"
---
 
## Description
 
Implement JWT authentication...
 
## Acceptance Criteria
 
- [x] User can login
- [ ] JWT token returned
 
## Implementation Plan
 
1. Research patterns
2. Implement
 
## Implementation Notes
 
Completed login endpoint.

Document Files

Each document is a markdown file with frontmatter:

---
title: "Auth Pattern"
description: "JWT authentication pattern"
tags: ["patterns", "security"]
createdAt: "2025-01-10T09:00:00Z"
updatedAt: "2025-01-12T16:00:00Z"
---
 
# Auth Pattern
 
This document describes our authentication pattern...

Git Integration

The .knowns/ folder is designed to be committed to git:

git add .knowns/
git commit -m "Add project knowledge base"

.gitignore

You may want to ignore certain files:

# Ignore time tracking state (optional)
.knowns/.timer

Configuration Commands

Manage project configuration via CLI:

# Get a config value
knowns config get defaultAssignee --plain
 
# Set a config value
knowns config set defaultAssignee "@john"
 
# List all config
knowns config list

AI Agent Guidelines

Knowns can sync guidelines to AI assistants:

# Interactive mode - select version and files
knowns agents
 
# Non-interactive update (uses defaults)
knowns agents --update-instructions
 
# Update specific files with MCP version
knowns agents --update-instructions --type mcp --files "CLAUDE.md,AGENTS.md"

Supported files:

CLAUDE.md - For Claude Code (default)
AGENTS.md - For Agent SDK (default)
GEMINI.md - For Google Gemini
.github/copilot-instructions.md - For GitHub Copilot

Environment Variables

Variable	Description
`KNOWNS_PORT`	Default port for `knowns browser`

Defaults

Setting	Default
Web UI port	6420
Task priority	medium
Task status	todo