@fungi.computer/spore 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,87 @@
-# Temporary Holding Version
+# Shiitake
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Spore (`@fungi.computer/spore`) installs Shiitake in your terminal or an ACP
+editor such as Zed. Conversations and project tools use a local background
+service; Fungi hosted models use the Team you choose at sign-in.
+
+## Install
+
+Install with Node 22.13 or newer and npm:
+
+```sh
+npm install -g @fungi.computer/spore
+fungi --version
+```
+
+Shiitake needs Linux x64/arm64 with glibc 2.35+, or macOS 13.5+ on Apple Silicon
+or Intel. Windows and Alpine/musl are not supported. The Node launcher reports
+this requirement before loading native code on an unsupported machine. Keep npm
+optional dependencies enabled: they supply the patch engine and pinned Bun
+runtime. A separate Bun installation is not required.
+
+On Apple Silicon, use arm64 Node. An x64 Node installation under Rosetta is
+refused before loading the Intel runtime; switch Node architectures and
+reinstall the CLI with optional dependencies enabled.
+
+## Start in your project
+
+```sh
+fungi login --provider fungi
+fungi
+```
+
+Approve browser sign-in and choose the Team that pays for models. Hosted models
+need Team credit. Use `/model` in the terminal to select a model such as Luna.
+Use `fungi login --help` for other provider options.
+
+Bare `fungi login` defaults to Fungi; use `--provider <id>` to choose another
+provider. Login does not change an existing Session's model.
+
+## Connect Zed
+
+Merge this entry into Zed's user settings:
+
+```json
+{
+  "agent_servers": {
+    "fungi": {
+      "type": "custom",
+      "command": "fungi",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+Open the project in Zed and choose **fungi** from the Agent panel's new-thread
+menu. Keep credentials out of editor settings. Use the editor's Stop control to
+cancel work and history to reopen saved conversations. Closing an editor only
+disconnects its client and can leave accepted work running.
+
+The [editor guide](https://docs.fungi.computer/guides/use-fungi-in-your-editor/)
+covers Neovim with Agentic.nvim, model selection for the same Session, generic
+ACP clients and troubleshooting. `fungi acp --help` describes the stdio entry
+point.
+
+## Inspect, resume and stop
+
+```sh
+fungi status
+fungi doctor
+fungi sessions list
+fungi resume
+```
+
+`fungi doctor` reports your platform, glibc version, saved Fungi sign-in, model
+configuration and HTTP reachability without displaying credentials. On an
+unsupported platform it reports the platform limit and leaves sign-in unchecked.
+It does not send a model prompt, verify Team credit or check for updates.
+
+Run these in the same project folder. `fungi stop` stops the shared service for
+all local clients without deleting saved Sessions. After updating the CLI,
+finish active work, stop the service, then reopen your editor's Agent.
+
+See [Fungi documentation](https://docs.fungi.computer/) for account, billing and
+support information. Third-party terms are preserved in `THIRD_PARTY_NOTICES`
+and `native/apply-patch/LICENSE.codex`.