knowns 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,74 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [0.1.2] - 2024-12-26
9
+
10
+ ### Added
11
+ - New `src/constants/knowns-guidelines.ts` file containing system prompt as TypeScript constant
12
+ - Auto-sync of Knowns guidelines to AI instruction files during `knowns init`
13
+ - Third step in "Next steps" output: "Update AI instructions: knowns agents --update-instructions"
14
+
15
+ ### Changed
16
+ - Refactored `agents` command to use bundled constant instead of reading from CLAUDE.md
17
+ - CLAUDE.md is now a target file (not source) - gets updated like other AI instruction files
18
+ - Exported `updateInstructionFile()` and `INSTRUCTION_FILES` from agents.ts for reusability
19
+ - System prompt now bundled into binary, eliminating file I/O during sync
20
+
21
+ ### Improved
22
+ - Faster agent instruction updates (no file reads required)
23
+ - More reliable init process - new projects get AI instructions automatically
24
+ - Simplified architecture: single source of truth for guidelines in codebase
25
+
26
+ ## [0.1.1] - 2024-12-26
27
+
28
+ ### Added
29
+ - GitHub Actions CI workflow for automated testing and linting
30
+ - GitHub Actions publish workflow for automated npm publishing
31
+ - Comprehensive badges in README (npm version, downloads, CI status, license, bundle size)
32
+ - Publishing guide documentation (.github/PUBLISHING.md)
33
+ - CHANGELOG.md to track version history
34
+
35
+ ### Changed
36
+ - Updated repository URLs from placeholder to knowns-dev/knowns
37
+ - Enhanced README with more professional badges and links
38
+
39
+ ### Fixed
40
+ - Repository and homepage URLs in package.json now point to correct GitHub organization
41
+
42
+ ## [0.1.0] - 2024-12-26
43
+
44
+ ### Added
45
+ - Initial release of Knowns CLI
46
+ - Task management with acceptance criteria
47
+ - Documentation management with nested folder support
48
+ - Context linking between tasks and documentation
49
+ - Time tracking built into tasks
50
+ - Search functionality across tasks and docs
51
+ - Web UI with Kanban board and document browser
52
+ - MCP (Model Context Protocol) server for AI integration
53
+ - Agent instruction sync (Claude, Gemini, Copilot)
54
+ - `--plain` flag for AI-readable output
55
+ - Multi-line input support for descriptions, plans, and notes
56
+ - Task workflow with plan, implementation notes, and status tracking
57
+ - Commands:
58
+ - `knowns init` - Initialize project
59
+ - `knowns task` - Task management commands
60
+ - `knowns doc` - Documentation commands
61
+ - `knowns search` - Global search
62
+ - `knowns browser` - Web UI
63
+ - `knowns agents` - Agent instruction sync
64
+ - `knowns time` - Time tracking
65
+ - `knowns mcp` - MCP server
66
+
67
+ ### Documentation
68
+ - Comprehensive README with usage examples
69
+ - CLAUDE.md with complete guidelines for AI agents
70
+ - Example workflows and patterns
71
+
72
+ [0.1.2]: https://github.com/knowns-dev/knowns/compare/v0.1.1...v0.1.2
73
+ [0.1.1]: https://github.com/knowns-dev/knowns/compare/v0.1.0...v0.1.1
74
+ [0.1.0]: https://github.com/knowns-dev/knowns/releases/tag/v0.1.0
package/README.md CHANGED
@@ -4,8 +4,11 @@
4
4
 
5
5
  CLI tool for dev teams to manage tasks and documentation with AI-first context linking.
6
6
 
7
- [![npm version](https://img.shields.io/npm/v/knowns.svg)](https://www.npmjs.com/package/knowns)
8
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
7
+ [![npm version](https://img.shields.io/npm/v/knowns.svg?style=flat-square)](https://www.npmjs.com/package/knowns)
8
+ [![npm downloads](https://img.shields.io/npm/dm/knowns.svg?style=flat-square)](https://www.npmjs.com/package/knowns)
9
+ [![CI](https://img.shields.io/github/actions/workflow/status/knowns-dev/knowns/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/knowns-dev/knowns/actions)
10
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](./LICENSE)
11
+ [![Bundle Size](https://img.shields.io/bundlephobia/min/knowns?style=flat-square)](https://bundlephobia.com/package/knowns)
9
12
 
10
13
  ## Why Knowns?
11
14
 
@@ -58,7 +61,11 @@ CLI tool for dev teams to manage tasks and documentation with AI-first context l
58
61
  ## Installation
59
62
 
60
63
  ```bash
64
+ # Using npm
61
65
  npm install -g knowns
66
+
67
+ # Or using bun
68
+ bun install -g knowns
62
69
  ```
63
70
 
64
71
  ## Quick Start
@@ -525,8 +532,9 @@ MIT © [Knowns Contributors](./LICENSE)
525
532
  ## Links
526
533
 
527
534
  - [npm package](https://www.npmjs.com/package/knowns)
528
- - [GitHub repository](https://github.com/yourusername/knowns)
529
- - [Issues](https://github.com/yourusername/knowns/issues)
535
+ - [GitHub repository](https://github.com/knowns-dev/knowns)
536
+ - [Issues](https://github.com/knowns-dev/knowns/issues)
537
+ - [Changelog](https://github.com/knowns-dev/knowns/releases)
530
538
 
531
539
  ---
532
540