mirror of
https://github.com/harivansh-afk/clanker-agent.git
synced 2026-04-18 23:02:14 +00:00
chore: rebrand companion-os to clanker-agent
- Rename all package names from companion-* to clanker-* - Update npm scopes from @mariozechner to @harivansh-afk - Rename config directories .companion -> .clanker - Rename environment variables COMPANION_* -> CLANKER_* - Update all documentation, README files, and install scripts - Rename package directories (companion-channels, companion-grind, companion-teams) - Update GitHub URLs to harivansh-afk/clanker-agent - Preserve full git history from companion-cloud monorepo
This commit is contained in:
parent
f93fe7d1a0
commit
67168d8289
356 changed files with 2249 additions and 10223 deletions
|
|
@ -1,14 +1,14 @@
|
|||
> companion can help you create companion packages. Ask it to bundle your extensions, skills, prompt templates, or themes.
|
||||
> clanker can help you create clanker packages. Ask it to bundle your extensions, skills, prompt templates, or themes.
|
||||
|
||||
# Companion Packages
|
||||
# Clanker Packages
|
||||
|
||||
Companion 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 `companion` key, or use conventional directories.
|
||||
Clanker 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 `clanker` key, or use conventional directories.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Install and Manage](#install-and-manage)
|
||||
- [Package Sources](#package-sources)
|
||||
- [Creating a Companion Package](#creating-a-companion-package)
|
||||
- [Creating a Clanker Package](#creating-a-clanker-package)
|
||||
- [Package Structure](#package-structure)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Package Filtering](#package-filtering)
|
||||
|
|
@ -17,32 +17,32 @@ Companion packages bundle extensions, skills, prompt templates, and themes so yo
|
|||
|
||||
## Install and Manage
|
||||
|
||||
> **Security:** Companion 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.
|
||||
> **Security:** Clanker 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
|
||||
companion install npm:@foo/bar@1.0.0
|
||||
companion install git:github.com/user/repo@v1
|
||||
companion install https://github.com/user/repo # raw URLs work too
|
||||
companion install /absolute/path/to/package
|
||||
companion install ./relative/path/to/package
|
||||
clanker install npm:@foo/bar@1.0.0
|
||||
clanker install git:github.com/user/repo@v1
|
||||
clanker install https://github.com/user/repo # raw URLs work too
|
||||
clanker install /absolute/path/to/package
|
||||
clanker install ./relative/path/to/package
|
||||
|
||||
companion remove npm:@foo/bar
|
||||
companion list # show installed packages from settings
|
||||
companion update # update all non-pinned packages
|
||||
clanker remove npm:@foo/bar
|
||||
clanker list # show installed packages from settings
|
||||
clanker update # update all non-pinned packages
|
||||
```
|
||||
|
||||
By default, `install` and `remove` write to global settings (`~/.companion/agent/settings.json`). Use `-l` to write to project settings (`.companion/settings.json`) instead. Project settings can be shared with your team, and companion installs any missing packages automatically on startup.
|
||||
By default, `install` and `remove` write to global settings (`~/.clanker/agent/settings.json`). Use `-l` to write to project settings (`.clanker/settings.json`) instead. Project settings can be shared with your team, and clanker installs any missing packages automatically on startup.
|
||||
|
||||
To try a package without installing it, use `--extension` or `-e`. This installs to a temporary directory for the current run only:
|
||||
|
||||
```bash
|
||||
companion -e npm:@foo/bar
|
||||
companion -e git:github.com/user/repo
|
||||
clanker -e npm:@foo/bar
|
||||
clanker -e git:github.com/user/repo
|
||||
```
|
||||
|
||||
## Package Sources
|
||||
|
||||
Companion accepts three source types in settings and `companion install`.
|
||||
Clanker accepts three source types in settings and `clanker install`.
|
||||
|
||||
### npm
|
||||
|
||||
|
|
@ -51,9 +51,9 @@ npm:@scope/pkg@1.2.3
|
|||
npm:pkg
|
||||
```
|
||||
|
||||
- Versioned specs are pinned and skipped by `companion update`.
|
||||
- Versioned specs are pinned and skipped by `clanker update`.
|
||||
- Global installs use `npm install -g`.
|
||||
- Project installs go under `.companion/npm/`.
|
||||
- Project installs go under `.clanker/npm/`.
|
||||
|
||||
### git
|
||||
|
||||
|
|
@ -69,21 +69,21 @@ ssh://git@github.com/user/repo@v1
|
|||
- 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 pin the package and skip `companion update`.
|
||||
- Cloned to `~/.companion/agent/git/<host>/<path>` (global) or `.companion/git/<host>/<path>` (project).
|
||||
- Refs pin the package and skip `clanker update`.
|
||||
- Cloned to `~/.clanker/agent/git/<host>/<path>` (global) or `.clanker/git/<host>/<path>` (project).
|
||||
- Runs `npm install` after clone or pull if `package.json` exists.
|
||||
|
||||
**SSH examples:**
|
||||
|
||||
```bash
|
||||
# git@host:path shorthand (requires git: prefix)
|
||||
companion install git:git@github.com:user/repo
|
||||
clanker install git:git@github.com:user/repo
|
||||
|
||||
# ssh:// protocol format
|
||||
companion install ssh://git@github.com/user/repo
|
||||
clanker install ssh://git@github.com/user/repo
|
||||
|
||||
# With version ref
|
||||
companion install git:git@github.com:user/repo@v1.0.0
|
||||
clanker install git:git@github.com:user/repo@v1.0.0
|
||||
```
|
||||
|
||||
### Local Paths
|
||||
|
|
@ -93,17 +93,17 @@ companion install git:git@github.com:user/repo@v1.0.0
|
|||
./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, companion loads resources using package rules.
|
||||
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, clanker loads resources using package rules.
|
||||
|
||||
## Creating a Companion Package
|
||||
## Creating a Clanker Package
|
||||
|
||||
Add a `companion` manifest to `package.json` or use conventional directories. Include the `companion-package` keyword for discoverability.
|
||||
Add a `clanker` manifest to `package.json` or use conventional directories. Include the `clanker-package` keyword for discoverability.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "my-package",
|
||||
"keywords": ["companion-package"],
|
||||
"companion": {
|
||||
"keywords": ["clanker-package"],
|
||||
"clanker": {
|
||||
"extensions": ["./extensions"],
|
||||
"skills": ["./skills"],
|
||||
"prompts": ["./prompts"],
|
||||
|
|
@ -116,13 +116,13 @@ Paths are relative to the package root. Arrays support glob patterns and `!exclu
|
|||
|
||||
### Gallery Metadata
|
||||
|
||||
The [package gallery](https://shittycodingagent.ai/packages) displays packages tagged with `companion-package`. Add `video` or `image` fields to show a preview:
|
||||
The [package gallery](https://clanker.dev/packages) displays packages tagged with `clanker-package`. Add `video` or `image` fields to show a preview:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "my-package",
|
||||
"keywords": ["companion-package"],
|
||||
"companion": {
|
||||
"keywords": ["clanker-package"],
|
||||
"clanker": {
|
||||
"extensions": ["./extensions"],
|
||||
"video": "https://example.com/demo.mp4",
|
||||
"image": "https://example.com/screenshot.png"
|
||||
|
|
@ -139,7 +139,7 @@ If both are set, video takes precedence.
|
|||
|
||||
### Convention Directories
|
||||
|
||||
If no `companion` manifest is present, companion auto-discovers resources from these directories:
|
||||
If no `clanker` manifest is present, clanker 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
|
||||
|
|
@ -148,11 +148,11 @@ If no `companion` manifest is present, companion auto-discovers resources from t
|
|||
|
||||
## 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 companion installs a package from npm or git, it runs `npm install`, so those dependencies are installed automatically.
|
||||
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 clanker installs a package from npm or git, it runs `npm install`, so those dependencies are installed automatically.
|
||||
|
||||
Companion 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: `@mariozechner/companion-ai`, `@mariozechner/companion-agent-core`, `@mariozechner/companion-coding-agent`, `@mariozechner/companion-tui`, `@sinclair/typebox`.
|
||||
Clanker 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: `@mariozechner/clanker-ai`, `@mariozechner/clanker-agent-core`, `@mariozechner/clanker-coding-agent`, `@mariozechner/clanker-tui`, `@sinclair/typebox`.
|
||||
|
||||
Other companion packages must be bundled in your tarball. Add them to `dependencies` and `bundledDependencies`, then reference their resources through `node_modules/` paths. Companion loads packages with separate module roots, so separate installs do not collide or share modules.
|
||||
Other clanker packages must be bundled in your tarball. Add them to `dependencies` and `bundledDependencies`, then reference their resources through `node_modules/` paths. Clanker loads packages with separate module roots, so separate installs do not collide or share modules.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -162,7 +162,7 @@ Example:
|
|||
"shitty-extensions": "^1.0.1"
|
||||
},
|
||||
"bundledDependencies": ["shitty-extensions"],
|
||||
"companion": {
|
||||
"clanker": {
|
||||
"extensions": ["extensions", "node_modules/shitty-extensions/extensions"],
|
||||
"skills": ["skills", "node_modules/shitty-extensions/skills"]
|
||||
}
|
||||
|
|
@ -199,7 +199,7 @@ Filter what a package loads using the object form in settings:
|
|||
|
||||
## Enable and Disable Resources
|
||||
|
||||
Use `companion config` to enable or disable extensions, skills, prompt templates, and themes from installed packages and local directories. Works for both global (`~/.companion/agent`) and project (`.companion/`) scopes.
|
||||
Use `clanker config` to enable or disable extensions, skills, prompt templates, and themes from installed packages and local directories. Works for both global (`~/.clanker/agent`) and project (`.clanker/`) scopes.
|
||||
|
||||
## Scope and Deduplication
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue