superbee 0.0.1 → 0.1.1-pre.2

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/NOTICE

@@ -0,0 +1,14 @@
+Superbee
+Copyright 2026 Holaxis
+
+This product includes software developed at Holaxis.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files
+except in compliance with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Portions of this software were previously distributed under the MIT License as
+"AgentState Lite" / "@holaxis/aslite", Copyright (c) 2026 Holaxis. Versions published under
+that name remain available under the MIT License; this relicensing governs subsequent
+releases only.

package/README.md

@@ -1,15 +1,102 @@
 # superbee
 
-**Shared agent memory.** A versioned markdown knowledge bundle that lives in your repo, plus a CLI that humans and AI agents both read and write.
+**An OKF-native, CLI-first, agent-facing knowledge store.** Context notes, docs, cross-links,
+and live bundle Views — as a plain folder of user-owned files that works offline,
+with an optional wire backend when a separate service hosts the bundle. `superbee` is the
+[Superbee](https://github.com/Holaxis-ai/superbee) project's CLI. Its historical `aslite` and
+`agentstate-lite` commands remain supported aliases for existing installations.
 
-Bees build comb one cell at a time, and the comb is a shared structure the whole colony reads from and adds to. That is what this is: agents coordinate by leaving durable marks in a shared store rather than by messaging each other.
+The npm artifact ships one self-contained executable file with **zero runtime dependencies**,
+plus the generated Agent Skill (`SKILL.md` and its `references/` folder — installable into host
+skill folders with `superbee skill install`). npm is the sole executable distribution channel;
+the installed Skill contains guidance and references, not a second CLI copy. Maintainers can
+reproduce the complete package proof from the
+repository root with `npm run verify:npm-package`; it builds, packs, installs into an isolated
+prefix, resolves both command names from `PATH`, and exercises an offline bundle workflow. This
+developer proof deliberately stamps `local-dev`, so it works on an in-progress/dirty checkout;
+`prepublishOnly` runs the same journey in strict `npm-package` mode and refuses unless Git proves
+an exact clean source commit.
+Install the supported default once (`superbee` is canonical; the legacy aliases `aslite` and
+`agentstate-lite` remain supported), then complete host setup:
 
-- Local-first and git-backed. Your knowledge is plain markdown in your repository.
-- Versioned with compare-and-swap writes, so concurrent agents cannot clobber each other.
-- Context notes, documents, cross-links, tasks, and artifacts in one bundle.
+```sh
+npm install -g superbee
+superbee setup
+```
 
-> **Status: placeholder.** This package name is reserved for an imminent open-source release. The first working version is on its way. Watch https://getsuperbee.com
+`setup` is the read-only integration front door. It asks for the exact host, checks npm, Agent
+Skill, SessionStart hook, MCP, bundle, and catalog state, then returns one safe `next.command`.
+Fill any explicit placeholder it identifies, follow that command, restart the host after
+integration changes, and rerun setup to verify. It never uses host detection as permission to
+edit configuration.
+
+Then run the first-value flow from an ordinary project directory:
+
+```sh
+superbee
+superbee recipes
+superbee init --create-only --recipe work-tracking --dir .agentstate-lite
+superbee new "Task" first-task --title "Plan the first change" \
+  --progress_status todo --actor quickstart-agent --dir .agentstate-lite
+superbee --dir .agentstate-lite
+```
+
+`--create-only` fails before writing when the selected target is occupied or ambiguous. Use
+`recipe add` instead when you intend to modify an existing bundle. Bring source material or intent
+to your agent in the tool you already use. The agent organizes, types, links, and updates the
+bundle through `superbee`; these commands are the plumbing, not a manual data-entry workflow.
+
+`quickstart-agent` is an advisory example actor label; replace it with the actual agent identity.
+
+Existing `.agentstate-lite/` bundles and `.agentstate.json` bindings need no migration. To try
+read-only and bootstrap commands without installing anything, run `npx -y superbee`; persistent
+integrations still require the global npm install.
+
+If upgrading from the retired marketplace plugin, remove or disable that plugin, then rerun
+`superbee setup` and follow its exact next command. The hook installer
+replaces exact historical AgentState marketplace hooks instead of adding a duplicate.
+
+## What it is
+
+A knowledge bundle is a directory of markdown that conforms to the **Open Knowledge Format
+(OKF)** — so it survives the tool: open it in any editor, render it on GitHub, diff it in git,
+hand it to someone else. On top of that portable format, `superbee` adds an agent-facing
+CLI (TOON output, a capped exit-code taxonomy, structured errors) and a local UI for live bundle
+Views.
+
+- **Local-first.** Everything works with the network off; the filesystem is the source of truth.
+- **Agent-native.** The primary interface is a small, predictable CLI designed to be driven by
+  AI agents, with a `SessionStart` hook installer for Claude Code / Codex / OpenCode.
+- **Human-visible.** In an MCP Apps conversation, an agent can call `show_document` with an exact
+  bundle ID to display the authoritative document through Superbee's bounded Markdown reader;
+  no executable View approval or separate Markdown tool is involved. Outside an MCP Apps host,
+  `superbee doc open <id>` opens that exact document in the same local browser reader;
+  `superbee ui --open` opens the bundle launcher. In the browser you can read rendered pages (cross-links you can follow,
+  derived backlinks), see a live activity
+  feed and the bundle's sharing status, and launch its registered Views — which present live data
+  through the read-only v0 bridge or propose one human-confirmed local scalar action through v1.
+  (`Page` is the retired legacy name for the View kind — legacy-named content no longer
+  registers; `superbee status` flags it and the repo's migration script renames it in place.)
+
+## Optional: a shared remote bundle
+
+Run the reference server over a local bundle, then point any command at it with `--remote`:
+
+```sh
+superbee serve --dir ./my-bundle    # loopback, keyless reference server
+superbee list --remote http://127.0.0.1:4818
+```
+
+The public package intentionally stops at this generic wire boundary. It does not ship a hosted
+deployment, identity system, account-administration commands, or cloud-provider recipe. A separate
+service can implement the same versioned storage and HTTP contracts without changing the local
+engine or CLI.
+
+## Documentation
+
+Run `superbee --help` (or any subcommand with `--help`) for the full command reference.
+Design and format docs live in the repository.
 
 ## License
 
-MIT
+MIT © Holaxis