@valni/cli-darwin-x64 0.1.2 → 0.1.3

package/runtime/docs/packages.md

@@ -1,228 +0,0 @@
-> valni can help you create valni packages. Ask it to bundle your extensions, skills, prompt templates, or themes.
-
-# Pi Packages
-
-Pi packages bundle extensions, skills, prompt templates, and themes so you can share them through npm or git. A package can declare resources in `package.json` under the `valni` key, or use conventional directories.
-
-## Table of Contents
-
-- [Install and Manage](#install-and-manage)
-- [Package Sources](#package-sources)
-- [Creating a Pi Package](#creating-a-pi-package)
-- [Package Structure](#package-structure)
-- [Dependencies](#dependencies)
-- [Package Filtering](#package-filtering)
-- [Enable and Disable Resources](#enable-and-disable-resources)
-- [Scope and Deduplication](#scope-and-deduplication)
-
-## Install and Manage
-
-> **Security:** Pi packages run with full system access. Extensions execute arbitrary code, and skills can instruct the model to perform any action including running executables. Review source code before installing third-party packages.
-
-```bash
-valni install npm:@foo/bar@1.0.0
-valni install git:github.com/user/repo@v1
-valni install https://github.com/user/repo  # raw URLs work too
-valni install /absolute/path/to/package
-valni install ./relative/path/to/package
-
-valni remove npm:@foo/bar
-valni list                     # show installed packages from settings
-valni update                   # update valni only
-valni update --all             # update valni, update packages, and reconcile pinned git refs
-valni update --extensions      # update packages and reconcile pinned git refs only
-valni update --models          # refresh model catalogs only
-valni update --self            # update valni only
-valni update --self --force    # reinstall valni even if current
-valni update npm:@foo/bar      # update one package
-valni update --extension npm:@foo/bar
-```
-
-These commands manage valni packages and `valni update` can update the valni CLI installation. To uninstall valni itself, see [Quickstart](quickstart.md#uninstall).
-
-By default, `install` and `remove` write to user settings (`~/.valni/agent/settings.json`). Use `-l` to write to project settings (`.valni/settings.json`) instead. Project settings can be shared with your team, and valni installs any missing packages automatically on startup after the project is trusted.
-
-To try a package without installing it, use `--extension` or `-e`. This installs to a temporary directory for the current run only:
-
-```bash
-valni -e npm:@foo/bar
-valni -e git:github.com/user/repo
-```
-
-## Package Sources
-
-Pi accepts three source types in settings and `valni install`.
-
-### npm
-
-```
-npm:@scope/pkg@1.2.3
-npm:pkg
-```
-
-- Versioned specs are pinned and skipped by package updates (`valni update --extensions`, `valni update --all`).
-- User installs go under `~/.valni/agent/npm/`.
-- Project installs go under `.valni/npm/`.
-- Set `npmCommand` in `settings.json` to pin npm package lookup and install operations to a specific wrapper command such as `mise` or `asdf`.
-
-Example:
-
-```json
-{
-  "npmCommand": ["mise", "exec", "node@20", "--", "npm"]
-}
-```
-
-### git
-
-```
-git:github.com/user/repo@v1
-git:git@github.com:user/repo@v1
-https://github.com/user/repo@v1
-ssh://git@github.com/user/repo@v1
-```
-
-- Without `git:` prefix, only protocol URLs are accepted (`https://`, `http://`, `ssh://`, `git://`).
-- With `git:` prefix, shorthand formats are accepted, including `github.com/user/repo` and `git@github.com:user/repo`.
-- HTTPS and SSH URLs are both supported.
-- SSH URLs use your configured SSH keys automatically (respects `~/.ssh/config`).
-- For non-interactive runs (for example CI), you can set `GIT_TERMINAL_PROMPT=0` to disable credential prompts and set `GIT_SSH_COMMAND` (for example `ssh -o BatchMode=yes -o ConnectTimeout=5`) to fail fast.
-- Refs are pinned tags or commits. `valni update --extensions` and `valni update --all` do not move them to newer refs, but they do reconcile an existing clone to the configured ref.
-- Use `valni install git:host/user/repo@new-ref` to update settings and move an existing package to a new pinned ref.
-- Cloned to `~/.valni/agent/git/<host>/<path>` (global) or `.valni/git/<host>/<path>` (project).
-- When reconciliation changes the checkout, valni resets and cleans the clone, then runs `npm install` if `package.json` exists.
-
-**SSH examples:**
-```bash
-# git@host:path shorthand (requires git: prefix)
-valni install git:git@github.com:user/repo
-
-# ssh:// protocol format
-valni install ssh://git@github.com/user/repo
-
-# With version ref
-valni install git:git@github.com:user/repo@v1.0.0
-```
-
-### Local Paths
-
-```
-/absolute/path/to/package
-./relative/path/to/package
-```
-
-Local paths point to files or directories on disk and are added to settings without copying. Relative paths are resolved against the settings file they appear in. If the path is a file, it loads as a single extension. If it is a directory, valni loads resources using package rules.
-
-## Creating a Pi Package
-
-Add a `valni` manifest to `package.json` or use conventional directories. Include the `pi-package` keyword for discoverability.
-
-```json
-{
-  "name": "my-package",
-  "keywords": ["pi-package"],
-  "valni": {
-    "extensions": ["./extensions"],
-    "skills": ["./skills"],
-    "prompts": ["./prompts"],
-    "themes": ["./themes"]
-  }
-}
-```
-
-Paths are relative to the package root. Arrays support glob patterns and `!exclusions`.
-
-### Gallery Metadata
-
-The [package gallery](https://pi.dev/packages) displays packages tagged with `pi-package`. Add `video` or `image` fields to show a preview:
-
-```json
-{
-  "name": "my-package",
-  "keywords": ["pi-package"],
-  "valni": {
-    "extensions": ["./extensions"],
-    "video": "https://example.com/demo.mp4",
-    "image": "https://example.com/screenshot.png"
-  }
-}
-```
-
-- **video**: MP4 only. On desktop, autoplays on hover. Clicking opens a fullscreen player.
-- **image**: PNG, JPEG, GIF, or WebP. Displayed as a static preview.
-
-If both are set, video takes precedence.
-
-## Package Structure
-
-### Convention Directories
-
-If no `valni` manifest is present, valni auto-discovers resources from these directories:
-
-- `extensions/` loads `.ts` and `.js` files
-- `skills/` recursively finds `SKILL.md` folders and loads top-level `.md` files as skills
-- `prompts/` loads `.md` files
-- `themes/` loads `.json` files
-
-## Dependencies
-
-Third party runtime dependencies belong in `dependencies` in `package.json`. Dependencies that do not register extensions, skills, prompt templates, or themes also belong in `dependencies`. When valni installs a package from npm or git, it runs `npm install`, so those dependencies are installed automatically.
-
-Pi bundles core packages for extensions and skills. If you import any of these, list them in `peerDependencies` with a `"*"` range and do not bundle them: `@valni/ai`, `@valni/agent-core`, `@valni/cli`, `@valni/tui`, `typebox`.
-
-Other valni packages must be bundled in your tarball. Add them to `dependencies` and `bundledDependencies`, then reference their resources through `node_modules/` paths. Pi loads packages with separate module roots, so separate installs do not collide or share modules.
-
-Example:
-
-```json
-{
-  "dependencies": {
-    "shitty-extensions": "^1.0.1"
-  },
-  "bundledDependencies": ["shitty-extensions"],
-  "valni": {
-    "extensions": ["extensions", "node_modules/shitty-extensions/extensions"],
-    "skills": ["skills", "node_modules/shitty-extensions/skills"]
-  }
-}
-```
-
-## Package Filtering
-
-Filter what a package loads using the object form in settings:
-
-```json
-{
-  "packages": [
-    "npm:simple-pkg",
-    {
-      "source": "npm:my-package",
-      "extensions": ["extensions/*.ts", "!extensions/legacy.ts"],
-      "skills": [],
-      "prompts": ["prompts/review.md"],
-      "themes": ["+themes/legacy.json"]
-    }
-  ]
-}
-```
-
-`+path` and `-path` are exact paths relative to the package root.
-
-- Omit a key to load all of that type.
-- Use `[]` to load none of that type.
-- `!pattern` excludes matches.
-- `+path` force-includes an exact path.
-- `-path` force-excludes an exact path.
-- Filters layer on top of the manifest. They narrow down what is already allowed.
-
-## Enable and Disable Resources
-
-Use `valni config` to enable or disable extensions, skills, prompt templates, and themes from installed packages and local directories. `valni config` starts in global settings (`~/.valni/agent/settings.json`); press Tab to switch between global and project-local modes. Use `valni config -l` to start in project overrides (`.valni/settings.json`) with inherited global resources dimmed.
-
-## Scope and Deduplication
-
-Packages can appear in both global and project settings. If the same package appears in both, the project entry wins unless the project entry has `autoload: false`, in which case it is applied as a delta over the global entry. Identity is determined by:
-
-- npm: package name
-- git: repository URL without ref
-- local: resolved absolute path