@hasna/knowledge 0.1.0 → 0.2.0

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,59 @@
+name: Bug Report
+description: Report a bug in open-knowledge
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a bug!
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear description of the bug
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Output of `open-knowledge --version`
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - macOS
+        - Linux
+        - Windows
+        - Other
+  - type: dropdown
+    id: runtime
+    attributes:
+      label: Runtime
+      options:
+        - Bun
+        - Node.js
+        - Other

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,34 @@
+name: Feature Request
+description: Suggest a new feature or improvement
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Ideas are welcome! The best features solve real problems for AI agents and CLI users.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem or Motivation
+      description: What problem does this solve?
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: How would you like it to work?
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Any other approaches you considered?
+  - type: checkboxes
+    id: willingness
+    attributes:
+      label: Willingness to Implement
+      options:
+        - label: I am willing to implement this feature
+        - label: I can help test a PR for this feature

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+## Summary
+
+<!-- 1-3 sentence description of the change -->
+
+## Motivation
+
+<!-- Why is this change needed? What problem does it solve? -->
+
+## Changes
+
+<!-- Bulleted list of what was changed -->
+
+## Testing
+
+<!-- How was this tested? -->
+
+## Checklist
+
+- [ ] Tests added / updated
+- [ ] Documentation updated (if needed)
+- [ ] `bun test` passes

package/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        runtime: [bun, node]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Bun
+        if: matrix.runtime == 'bun'
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Setup Node
+        if: matrix.runtime == 'node'
+        uses: actions/setup-node@v4
+        with:
+          node-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run tests
+        run: bun test
+
+  test-matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        runtime: [bun]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bun install
+      - run: bun test

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,31 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+* The use of sexualized language or imagery and unwelcome sexual attention
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

package/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to open-knowledge
+
+Thank you for your interest in contributing!
+
+## Development Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/hasna/knowledge.git
+cd knowledge
+
+# Install dependencies (Bun)
+bun install
+
+# Run tests
+bun test
+
+# Run a specific test file
+bun test tests/cli.test.ts
+```
+
+## Project Structure
+
+```
+knowledge/
+├── src/
+│   ├── cli.js    # CLI entry point, argument parsing, commands
+│   └── store.js  # Persistent store, file locking, ID generation
+├── tests/
+│   └── cli.test.ts  # Integration tests using Bun.test
+├── package.json
+└── LICENSE
+```
+
+## Design Principles
+
+**Agent-friendly first**: every output should be parseable by an LLM. Prefer `--json` for structured data. Keep error messages actionable.
+
+**Minimal dependencies**: keep the dependency footprint small. The store is a plain JSON file.
+
+**Safe by default**: destructive operations require explicit confirmation flags (`--yes`).
+
+**Concurrent-safe**: all store mutations go through `withLock()`. Do not bypass it.
+
+## Commit Conventions
+
+Use [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat(cli): add --tag filter on list command
+fix(store): handle empty store file gracefully
+docs(readme): add installation instructions
+```
+
+Types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test`
+
+## Pull Request Process
+
+1. Fork the repo and create a branch from `main`.
+2. Add tests for new functionality.
+3. Ensure all tests pass: `bun test`.
+4. Keep commits atomic and well-described.
+5. Open a PR with a clear description of the change and motivation.
+
+## Code Style
+
+- 2-space indentation
+- `for` loops over array methods where performance matters
+- Descriptive variable names
+- No unnecessary dependencies
+
+## Reporting Issues
+
+- Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.yml)
+- Search existing issues first
+- Include: Node/Bun version, OS, steps to reproduce, expected vs actual
+
+## Suggesting Features
+
+Open a [feature request issue](.github/ISSUE_TEMPLATE/feature_request.yml) describing:
+- The problem you're solving
+- How you envision the solution
+- Whether you're willing to implement it

package/FUNDING.yml

@@ -0,0 +1 @@
+github: hasna

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,146 @@
+# open-knowledge
+
+> Agent-friendly local knowledge CLI with JSON output, pagination, and safe destructive actions.
+
+[![npm version](https://img.shields.io/npm/v/@hasna/knowledge)](https://npm.im/@hasna/knowledge)
+[![license](https://img.shields.io/npm/l/@hasna/knowledge)](LICENSE)
+[![build](https://img.shields.io/github/actions/workflow/status/hasna/knowledge/ci.yml)](.github/workflows/ci.yml)
+
+A flat key-value knowledge store designed for AI agents. Stores notes with titles, content, source URLs, and tags. Works with Bun and Node.js.
+
+## Install
+
+```bash
+# Bun
+bun add -g @hasna/knowledge
+
+# npm
+npm install -g @hasna/knowledge
+```
+
+Or run directly:
+
+```bash
+bun x @hasna/knowledge add "My Note" "Some content"
+```
+
+## Quick Start
+
+```bash
+# Add a note
+open-knowledge add "Rust ownership" "Every value has exactly one owner"
+
+# List all notes
+open-knowledge list
+
+# List with search
+open-knowledge list --search ownership
+
+# List notes tagged "rust"
+open-knowledge list --tag rust
+
+# Get a note
+open-knowledge get --id <id>
+
+# Update a note
+open-knowledge update --id <id> --title "Rust ownership model"
+
+# Delete a note (requires --yes)
+open-knowledge delete --id <id> --yes
+
+# Export all notes as JSONL
+open-knowledge export --format jsonl
+```
+
+## Commands
+
+### add
+```bash
+open-knowledge add <title> <content> [--url <url>] [-t <tag>]
+```
+Add a new knowledge item.
+
+### list
+```bash
+open-knowledge list|ls [options]
+```
+List items with pagination, search, and tag filtering.
+
+| Flag | Description |
+|------|-------------|
+| `-p, --page <n>` | Page number (default: 1) |
+| `-l, --limit <n>` | Items per page (default: 20) |
+| `-s, --search <text>` | Filter by title or content |
+| `-t, --tag <tag>` | Filter by tag |
+| `--sort created\|title` | Sort field (default: created) |
+| `--desc` | Sort descending |
+
+### get
+```bash
+open-knowledge get --id <id>
+```
+Retrieve a single item by ID.
+
+### update
+```bash
+open-knowledge update|edit --id <id> [options]
+```
+Update an existing item.
+
+| Flag | Description |
+|------|-------------|
+| `--title <title>` | New title |
+| `--content <content>` | New content |
+| `--url <url>` | New source URL |
+| `-t, --tag <tag>` | Add a tag |
+
+### delete
+```bash
+open-knowledge delete|rm --id <id> --yes
+```
+Delete an item. Requires `--yes` to confirm.
+
+### export
+```bash
+open-knowledge export [--format jsonl]
+```
+Export all items. Use `--format jsonl` for newline-delimited JSON.
+
+### help
+```bash
+open-knowledge help [command]
+```
+
+## Global Options
+
+| Flag | Description |
+|------|-------------|
+| `--json` | Output raw JSON |
+| `--store <path>` | Override store path |
+| `--version, -v` | Show version |
+| `--help, -h` | Show help |
+
+## Store Location
+
+Default store: `~/.open-knowledge/db.json`
+
+Override with `--store <path>` or set `OPEN_KNOWLEDGE_STORE` env var.
+
+## JSON Output
+
+Every command returns structured JSON when `--json` is passed:
+
+```json
+{
+  "ok": true,
+  "item": { "id": "...", "title": "...", "content": "...", "url": null, "tags": [], "created_at": "...", "updated_at": "..." }
+}
+```
+
+## Agent-Friendly Design
+
+- **JSON-only mode**: `--json` flag for easy parsing by LLMs
+- **Idempotent IDs**: each item gets a stable unique ID
+- **Safe deletes**: `--yes` flag required; no accidental deletions
+- **Concurrent-safe**: file locking prevents corruption from parallel agents
+- **Scriptable**: works in pipelines, CI, and any automation tool

package/SECURITY.md

@@ -0,0 +1,39 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please report it responsibly.
+
+**Do not open a public GitHub issue** for security vulnerabilities.
+
+Please send details privately:
+
+1. **Email**: Send to the maintainer directly via GitHub.
+2. **GitHub Security Advisories**: Use the [Security Advisories](https://github.com/hasna/knowledge/security/advisories/new) feature to report privately.
+
+Include in your report:
+- Description of the vulnerability
+- Steps to reproduce
+- Potential impact
+- Any suggested fixes (optional)
+
+## Response Timeline
+
+- **Acknowledgment**: within 48 hours
+- **Initial assessment**: within 5 days
+- **Fix timeline**: depends on severity; critical issues are addressed immediately
+
+## Scope
+
+This project stores data in a local JSON file (`~/.open-knowledge/db.json` by default). Security considerations:
+
+- Store file permissions should be restricted to the owner
+- No network access or remote code execution
+- No authentication (local CLI tool)
+- Encryption of the store file is not currently implemented