akm-cli 0.2.1 → 0.3.0-rc2

package/LICENSE

@@ -2,7 +2,6 @@ Mozilla Public License Version 2.0
 ==================================
 
 1. Definitions
-
 --------------
 
 1.1. "Contributor"
@@ -84,8 +83,7 @@ Mozilla Public License Version 2.0
     fifty percent (50%) of the outstanding shares or beneficial
     ownership of such entity.
 
-1. License Grants and Conditions
-
+2. License Grants and Conditions
 --------------------------------
 
 2.1. Grants
@@ -156,8 +154,7 @@ equivalents.
 Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
 in Section 2.1.
 
-1. Responsibilities
-
+3. Responsibilities
 -------------------
 
 3.1. Distribution of Source Form
@@ -219,8 +216,7 @@ 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
-
+4. Inability to Comply Due to Statute or Regulation
 ---------------------------------------------------
 
 If it is impossible for You to comply with any of the terms of this
@@ -229,12 +225,12 @@ 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
+Software under the name "LEGAL", with additions for new restrictions
+placed at the end of the file. 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.
 
+5. Termination
 --------------
 
 5.1. The rights granted under this License will terminate automatically
@@ -264,53 +260,48 @@ have been validly granted by You or Your distributors under this License
 prior to termination shall survive termination.
 
 ************************************************************************
-
 *                                                                      *
-* 1. Disclaimer of Warranty                                           *
-* -------------------------                                           *
+*  6. 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.         *
+*  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                                          *
-* --------------------------                                          *
+*  7. 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.                                    *
+*  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
-
+8. Litigation
 -------------
 
 Any litigation relating to this License may be brought only in the
@@ -320,8 +311,7 @@ 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
-
+9. Miscellaneous
 ----------------
 
 This License represents the complete agreement concerning the subject
@@ -331,8 +321,7 @@ 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. Versions of the License
 ---------------------------
 
 10.1. New Versions
@@ -369,7 +358,7 @@ 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/>.
+  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

package/README.md

@@ -1,112 +1,53 @@
-# Agent Kit Manager
+# akm -- Agent Kit Manager
 
-> **akm** — Agent Kit Manager
+> **akm** (Agent Kit Manager) -- A package manager for AI agent skills, commands, tools, and knowledge.
 
 [![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)
+[![npm downloads](https://img.shields.io/npm/dm/akm-cli)](https://www.npmjs.com/package/akm-cli)
+[![license](https://img.shields.io/github/license/itlackey/akm)](https://github.com/itlackey/akm/blob/main/LICENSE)
 
-A package manager for AI agent capabilities -- scripts, skills, commands,
-agents, knowledge, and memories -- that works with any AI coding assistant that
-can run shell commands.
+`akm` is a package manager for AI agent capabilities -- scripts, skills, commands,
+agents, knowledge, and memories. It works with any AI coding assistant that can
+run shell commands, including [Claude Code](https://claude.ai/code),
+[OpenCode](https://opencode.ai), [Cursor](https://cursor.com), and more.
 
 ## Install
 
 ```sh
-# Standalone binary (no runtime dependencies)
-curl -fsSL https://raw.githubusercontent.com/itlackey/agentikit/main/install.sh | bash
-
-# Or via Bun
 bun install -g akm-cli
 ```
 
-Upgrade in place with `akm upgrade`.
+Requires [Bun](https://bun.sh) runtime. Upgrade in place with `akm upgrade`.
 
 ## Quick Start
 
 ```sh
 akm setup                         # Guided setup: configure, initialize, and index
 akm add github:owner/repo         # Add a kit from GitHub
-akm search "deploy"               # Find assets
+akm search "deploy"               # Find assets across all sources
 akm show script:deploy.sh         # View details and run command
 ```
 
-If you want to skip the wizard, `akm init --dir ~/custom-stash` initializes the
-working stash at a custom path.
+## Why akm?
 
-## Features
+- **Works with any AI agent** -- No plugins or SDKs required. Any model that can run shell commands can use `akm`.
+- **One command to search everything** -- Local stash, registries, and community skills from [skills.sh](https://skills.sh) in a single query.
+- **Install kits from anywhere** -- npm, GitHub, GitLab, local directories.
+- **Semantic search** -- Optional local embeddings (via Ollama or HuggingFace) for finding assets by meaning, not just keywords.
+- **Private registries** -- Host your own registry for team or enterprise use.
 
-### Works with Any AI Agent
+## Agent Integration
 
-Any model that can run shell commands can use `akm`. Add this to your
-`AGENTS.md`, `CLAUDE.md`, or system prompt:
+Add this to your `AGENTS.md`, `CLAUDE.md`, or system prompt:
 
-~~~markdown
+```markdown
 ## Resources & Capabilities
 
 You have access to a searchable library of scripts, skills, commands, agents,
 knowledge, and memories via the `akm` CLI. Use `akm -h` for details.
-~~~
-
-No plugins, SDKs, or integration code required. Platform-specific plugins
-(e.g., [OpenCode](https://github.com/itlackey/akm-plugins?tab=readme-ov-file#opencode))
-are available for tighter integration but purely optional.
-
-### Clone Assets Anywhere
-
-`akm clone` copies any asset from your stash or a remote source into a
-target directory for local editing:
-
-```sh
-akm clone script:deploy.sh                              # Clone to your stash
-akm clone script:deploy.sh --dest ./project/.claude     # Clone to a specific directory
-akm clone script:deploy.sh --name my-deploy.sh          # Clone with a new name
-akm clone "npm:@scope/pkg//script:deploy.sh" --force    # Clone from a remote package
-```
-
-Key behaviors:
-- Type subdirectories are appended automatically (e.g., `--dest ./project/.claude` becomes `./project/.claude/scripts/deploy.sh`)
-- Skills clone as entire directories; scripts/commands clone as single files
-- Remote packages are fetched on-demand without registering as installed kits
-- `--force` overwrites existing assets
-
-### skills.sh Integration
-
-`akm` includes [skills.sh](https://skills.sh) as a built-in registry. Community
-skills from skills.sh are searchable out of the box alongside the official
-registry -- no setup required:
-
-```sh
-akm search "code review"             # Searches skills.sh and official registry
-akm registry search "code review"    # Search registries directly
 ```
 
-Results include install counts and link back to skills.sh for details. The
-provider caches queries for 15 minutes with a 24-hour stale fallback.
-
-### Registries and Private Registry Support
-
-Registries are indexes of available kits. The official
-[akm-registry](https://github.com/itlackey/akm-registry) is pre-configured.
-
-```sh
-akm registry search "code review"                                        # Search registries
-akm registry add https://example.com/registry/index.json --name team     # Add a registry
-akm stash add http://host:1933 --provider openviking \
-  --options '{"apiKey":"key"}'                                            # Add an OpenViking stash source
-akm registry list                                                        # List configured registries
-akm show viking://resources/my-doc                                       # Fetch remote content from OpenViking
-```
-
-Private access is supported through:
-- **GitHub tokens** -- Set `GITHUB_TOKEN` to access private GitHub repos when installing kits
-- **Provider options** -- `--options` flag accepts JSON for provider-specific configuration (API keys, custom headers)
-- **Pluggable providers** -- Built-in registry providers include `static-index` and `skills-sh`; stash providers include `filesystem` and `openviking`; custom providers can implement their own authentication
-
-See the [Registry docs](docs/registry.md) for hosting your own registry and
-the v2 index format.
-
-### Install Kits from Anywhere
+## Install Kits from Anywhere
 
 ```sh
 akm add @scope/my-kit                       # npm
@@ -117,26 +58,23 @@ akm add ./path/to/local/kit                 # Local directory
 
 Manage kits with `akm list`, `akm update --all`, and `akm remove`.
 
-### Publish Your Own Kit
+## Publish Your Own Kit
 
 1. Organize your assets into a directory
-2. Add `"akm"` to `keywords` in `package.json` or the `akm` topic to your GitHub repo
+2. Add `"akm"` to `keywords` in `package.json`
 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.
-
 ## Documentation
 
-| Doc | Description |
-| --- | --- |
-| [Getting Started](docs/getting-started.md) | Quick setup guide |
-| [CLI Reference](docs/cli.md) | All commands and flags |
-| [Configuration](docs/configuration.md) | Settings, providers, and Ollama setup |
-| [Concepts](docs/concepts.md) | Stashes, kits, registries, asset types |
-| [Kit Maker's Guide](docs/kit-makers.md) | Build and share kits |
-| [Registry](docs/registry.md) | Registries, search, and the v2 index format |
+Full docs, CLI reference, and guides are available on [GitHub](https://github.com/itlackey/akm):
+
+- [Getting Started](https://github.com/itlackey/akm/blob/main/docs/getting-started.md)
+- [CLI Reference](https://github.com/itlackey/akm/blob/main/docs/cli.md)
+- [Configuration](https://github.com/itlackey/akm/blob/main/docs/configuration.md)
+- [Kit Maker's Guide](https://github.com/itlackey/akm/blob/main/docs/kit-makers.md)
+- [Registry](https://github.com/itlackey/akm/blob/main/docs/registry.md)
 
 ## License
 
-[MPL-2.0](LICENSE)
+[MPL-2.0](https://github.com/itlackey/akm/blob/main/LICENSE)