akm-cli 0.0.0 → 0.0.16

package/LICENSE

@@ -0,0 +1,385 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+1. License Grants and Conditions
+
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+1. Responsibilities
+
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+1. Inability to Comply Due to Statute or Regulation
+
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+1. Termination
+
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+
+*                                                                      *
+* 1. Disclaimer of Warranty                                           *
+* -------------------------                                           *
+*                                                                      *
+* Covered Software is provided under this License on an "as is"       *
+* basis, without warranty of any kind, either expressed, implied, or  *
+* statutory, including, without limitation, warranties that the       *
+* Covered Software is free of defects, merchantable, fit for a        *
+* particular purpose or non-infringing. The entire risk as to the     *
+* quality and performance of the Covered Software is with You.        *
+* Should any Covered Software prove defective in any respect, You     *
+* (not any Contributor) assume the cost of any necessary servicing,   *
+* repair, or correction. This disclaimer of warranty constitutes an   *
+* essential part of this License. No use of any Covered Software is   *
+* authorized under this License except under this disclaimer.         *
+*                                                                      *
+
+************************************************************************
+
+************************************************************************
+
+*                                                                      *
+* 1. Limitation of Liability                                          *
+* --------------------------                                          *
+*                                                                      *
+* Under no circumstances and under no legal theory, whether tort      *
+* (including negligence), contract, or otherwise, shall any           *
+* Contributor, or anyone who distributes Covered Software as          *
+* permitted above, be liable to You for any direct, indirect,         *
+* special, incidental, or consequential damages of any character      *
+* including, without limitation, damages for lost profits, loss of    *
+* goodwill, work stoppage, computer failure or malfunction, or any    *
+* and all other commercial damages or losses, even if such party      *
+* shall have been informed of the possibility of such damages. This   *
+* limitation of liability shall not apply to liability for death or   *
+* personal injury resulting from such party's negligence to the       *
+* extent applicable law prohibits such limitation. Some               *
+* jurisdictions do not allow the exclusion or limitation of           *
+* incidental or consequential damages, so this exclusion and          *
+* limitation may not apply to You.                                    *
+*                                                                      *
+
+************************************************************************
+
+1. Litigation
+
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+1. Miscellaneous
+
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+1. Versions of the License
+
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at <https://mozilla.org/MPL/2.0/>.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -1,9 +1,301 @@
-# akm-cli
+# akm — the Agent-i-Kit Manager
 
-> This is a placeholder package. The real thing is coming soon.
+[![npm version](https://img.shields.io/npm/v/akm-cli)](https://www.npmjs.com/package/akm-cli)
+[![CI](https://github.com/itlackey/agentikit/actions/workflows/ci.yml/badge.svg)](https://github.com/itlackey/agentikit/actions/workflows/ci.yml)
+[![license](https://img.shields.io/npm/l/akm-cli)](LICENSE)
 
-**akm** — the Agent-i-Kit — is a package manager for AI agent capabilities:
-tools, skills, commands, agents, and knowledge documents.
+A package manager for AI agent capabilities — tools, skills, commands, agents,
+knowledge, and scripts — that works with any AI coding assistant that can run
+shell commands.
 
-- GitHub: https://github.com/itlackey/agentikit
-- License: MPL-2.0
+You build up useful scripts, prompts, and agent configs. `akm` (the Agent-i-Kit
+Manager) lets you organize them into a searchable **stash**, share them as
+installable **kits**, and give any model a way to discover and use them. No
+plugins required — just CLI output any tool-calling model can read.
+
+## Requirements
+
+`akm` requires [Bun](https://bun.sh) v1.0+ as its runtime. It uses Bun-specific
+APIs (`bun:sqlite`) that are **not available in Node.js**.
+
+## Quick Start
+
+```sh
+# Install (requires Bun v1.0+)
+bun install -g akm-cli
+
+# Initialize your stash
+akm init
+
+# Add a kit from GitHub
+akm add github:owner/repo
+
+# Search for assets
+akm search "deploy"
+
+# Show an asset
+akm show script:deploy.sh
+```
+
+> **Don't want Bun?** Use the [standalone binary](#standalone-binary) instead — it
+> bundles everything and has no runtime dependencies.
+
+## Using With Any AI Agent
+
+`akm` is platform agnostic. Any model that can execute shell commands can search
+your stash and use what it finds. The workflow is three commands:
+
+1. `akm search "what you need"` — find relevant assets (returns JSON by default)
+2. `akm show <ref>` — get the details (run command, instructions, prompt, etc.)
+3. Use the asset — execute the `run` command, follow the skill instructions, fill in the template
+
+### Drop-in prompt snippet
+
+Add this to your `AGENTS.md`, `CLAUDE.md`, `.github/copilot-instructions.md`, system prompt, or any instruction
+file to give your agent access to your stash without any additional setup:
+
+~~~markdown
+
+You have access to a searchable library of tools, skills, commands, agents,
+and knowledge documents via `akm`. Use it to find and
+use capabilities before writing something from scratch.
+
+**Finding assets:**
+```sh
+akm search "<query>"              # Search by keyword
+akm search "<query>" --type tool  # Filter by type (tool, skill, command, agent, knowledge, script)
+akm search "<query>" --source <source>  # Filter by source (e.g., "local", "registry", "both")
+```
+
+Search returns brief JSON by default. Local hits include a `ref` handle you
+pass directly to `akm show`.
+
+**Using assets:**
+```sh
+akm show <ref>                    # Get full asset details
+```
+
+What you get back depends on the asset type:
+- **script** — A `run` command you can execute directly
+- **skill** — Instructions to follow (read the full content)
+- **command** — A prompt template with placeholders to fill in
+- **agent** — A system prompt with model and tool hints
+- **knowledge** — A reference doc (use `toc` or `section "..."` to navigate)
+
+Always search the stash first when you need a capability. Prefer existing
+assets over writing new code.
+
+Use `akm -h` for more options and details on searching and using assets.
+
+~~~
+
+That's it. No plugin, no SDK, no integration code. The model reads the JSON
+output from `akm` and acts on it.
+
+### Platform plugins (optional)
+
+For tighter integration, plugins are available for some platforms. These add
+native tool bindings so the agent doesn't need to shell out, but they're
+purely optional — the CLI works everywhere.
+
+**OpenCode** — Add the [OpenCode plugin](https://github.com/itlackey/agentikit-plugins?tab=readme-ov-file#akm-opencode) to your `opencode.json`:
+
+```json
+{
+  "plugin": ["akm-opencode"]
+}
+```
+
+**Claude Code** — Add the prompt snippet above to your `CLAUDE.md` or
+project instructions. Claude Code can run `akm` commands directly.
+
+**Everything else** — If your agent can run shell commands, it can use `akm`.
+Add the prompt snippet to whatever instruction mechanism your platform uses.
+
+## What's In a Kit?
+
+A kit is a directory of assets you can share and install. There's no required
+structure — `akm` classifies assets by **file extension and content**, not by
+directory name. A `.sh` file is a script whether it lives in `scripts/`,
+`deploy/`, or at the root. A `.md` file with `tools` in its frontmatter is an
+agent definition wherever you put it.
+
+That said, using these directory names as an opt-in convention improves
+indexing confidence:
+
+```text
+my-kit/
+  scripts/        # Executable scripts (.sh, .ts, .js, .py, .rb, .go, etc.)
+  skills/         # Skill definitions (directories with SKILL.md)
+  commands/       # Slash commands (.md with $ARGUMENTS or agent frontmatter)
+  agents/         # Agent definitions (.md with model/tools frontmatter)
+  knowledge/      # Reference documents (.md)
+```
+
+### Asset types
+
+| Type | What it is | What the agent gets |
+| --- | --- | --- |
+| **script** | An executable script | A `run` command with auto-detected interpreter, plus optional `setup` and `cwd` |
+| **skill** | A set of instructions | Step-by-step guidance the agent follows |
+| **command** | A prompt template | A template with placeholders to fill in |
+| **agent** | An agent definition | A system prompt, model hint, and tool policy |
+| **knowledge** | A reference document | Navigable content with TOC and section views |
+
+Assets are referenced by type and name (e.g. `script:deploy.sh`,
+`knowledge:api-guide`). In practice, agents should treat the `ref` returned
+by search as an opaque handle and pass it back to `akm show`. See
+[Concepts](docs/concepts.md) and [Ref Format](docs/ref.md).
+
+## The Stash
+
+Your stash is the local library where assets live. It combines three sources
+in priority order:
+
+1. **Primary stash** — Your personal assets (`AKM_STASH_DIR`), created by `akm init`
+2. **Search paths** — Additional directories (team shares, project dirs, etc.)
+3. **Installed kits** — Kits from npm, GitHub, or git via `akm add` (cache-managed)
+
+The first match wins, so local assets always override installed ones. Use
+`akm clone` to fork an installed asset into your stash for editing.
+
+## Searching and Showing Assets
+
+Search returns brief JSON by default. Use `--detail normal` or `--detail full`
+when you want origin, tags, or explainability metadata:
+
+```sh
+akm search "docker" --type tool
+```
+
+```json
+{
+  "hits": [
+    {
+      "name": "docker-build",
+      "type": "script",
+      "description": "Build and push Docker images",
+      "action": "akm show script:docker-build.sh -> execute the run command"
+    }
+  ]
+}
+```
+
+Show returns everything the agent needs to act:
+
+```sh
+akm show tool:docker-build.sh
+```
+
+```json
+{
+  "type": "script",
+  "name": "docker-build.sh",
+  "origin": null,
+  "action": "Execute the run command below",
+  "run": "bash /path/to/tools/docker-build.sh",
+  "setup": "bun install",
+  "cwd": "/path/to/tools"
+}
+```
+
+For knowledge assets, navigate without loading the entire document:
+
+```sh
+akm show knowledge:api-guide toc
+akm show knowledge:api-guide section "Authentication"
+```
+
+## Installing and Sharing Kits
+
+Install kits from npm, GitHub, any git host, or local directories:
+
+```sh
+akm add @scope/my-kit                       # npm
+akm add github:owner/repo#v1.2.3            # GitHub with tag
+akm add git+https://gitlab.com/org/kit      # Any git repo
+akm add ./path/to/local/kit                 # Local directory
+```
+
+Search the registry for community kits:
+
+```sh
+akm search "code review" --source registry
+```
+
+Manage installed kits:
+
+```sh
+akm list                        # Show installed kits with status
+akm update --all                # Update all (reports version changes)
+akm remove owner/repo           # Remove and reindex
+akm clone tool:deploy.sh        # Fork an asset into your stash for editing
+```
+
+### Publishing your own kit
+
+1. Organize your assets (directory conventions are optional)
+2. Add `"akm"` to `keywords` in `package.json` or add the `akm` topic to your GitHub repo
+3. Optionally add `akm.include` in `package.json` to control what gets installed
+4. Publish to npm or push to GitHub
+
+See the [Kit Maker's Guide](docs/kit-makers.md) for a full walkthrough.
+
+## Installation
+
+`akm` requires [Bun](https://bun.sh) v1.0+ as its runtime. It uses Bun-specific
+APIs (`bun:sqlite`) that are not available in Node.js.
+
+```sh
+# Install Bun if you don't have it
+curl -fsSL https://bun.sh/install | bash
+
+# Install akm
+bun install -g akm-cli
+```
+
+### Standalone binary
+
+The standalone binary bundles everything and has **no runtime dependencies** —
+no Bun, no Node.js.
+
+```sh
+# macOS / Linux
+curl -fsSL https://raw.githubusercontent.com/itlackey/agentikit/main/install.sh | bash
+
+# Windows (PowerShell)
+irm https://raw.githubusercontent.com/itlackey/agentikit/main/install.ps1 -OutFile install.ps1; ./install.ps1
+```
+
+The shell installer verifies the binary against release checksums.
+
+Upgrade the binary in place:
+
+```sh
+akm upgrade           # Download and replace the running binary
+akm upgrade --check   # Check for updates without installing
+```
+
+## Documentation
+
+| Doc | Description |
+| --- | --- |
+| [Concepts](docs/concepts.md) | Asset types, classification, stash sources, metadata |
+| [CLI Reference](docs/cli.md) | All `akm` commands and flags |
+| [Kit Maker's Guide](docs/kit-makers.md) | Build and share a kit on GitHub, npm, or a network share |
+| [Registry](docs/registry.md) | Finding, installing, and publishing kits |
+| [Search](docs/search.md) | Hybrid search architecture and scoring |
+| [Indexing](docs/indexing.md) | How the search index is built |
+| [Filesystem](docs/filesystem.md) | Directory layout and `.stash.json` schema |
+| [Configuration](docs/configuration.md) | Providers, settings, and Ollama setup |
+| [Ref Format](docs/ref.md) | Opaque asset handles returned by `search` and consumed by `show` |
+
+## Status
+
+`akm` is approaching v1.0. The core CLI, stash model, and registry are stable
+and in daily use. Feedback, issues, and PRs welcome — especially around
+real-world usage patterns and integrations with different AI coding assistants.
+
+## License
+
+[MPL-2.0](LICENSE)