Skip to content

packages.md

Latest commit

 

History

History
197 lines (146 loc) · 6.83 KB

packages.md

File metadata and controls

197 lines (146 loc) · 6.83 KB
Raw

dreb can help you create dreb packages. Ask it to bundle your extensions, skills, prompt templates, or themes.

dreb Packages

dreb 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 dreb key, or use conventional directories.

Table of Contents

Install and Manage

Security: dreb 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.

dreb install npm:@foo/bar@1.0.0
dreb install git:github.com/user/repo@v1
dreb install https://github.com/user/repo  # raw URLs work too
dreb install /absolute/path/to/package
dreb install ./relative/path/to/package

dreb remove npm:@foo/bar
dreb list    # show installed packages from settings
dreb update  # update all non-pinned packages

By default, install and remove write to global settings (~/.dreb/agent/settings.json). Use -l to write to project settings (.dreb/settings.json) instead. Project settings can be shared with your team, and dreb 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:

dreb -e npm:@foo/bar
dreb -e git:github.com/user/repo

Package Sources

dreb accepts three source types in settings and dreb install.

npm

npm:@scope/pkg@1.2.3
npm:pkg
  • Versioned specs are pinned and skipped by dreb update.
  • Global installs use npm install -g.
  • Project installs go under .dreb/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:

{
  "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 pin the package and skip dreb update.
  • Cloned to ~/.dreb/agent/git/<host>/<path> (global) or .dreb/git/<host>/<path> (project).
  • Runs npm install after clone or pull if package.json exists.

SSH examples:

# git@host:path shorthand (requires git: prefix)
dreb install git:git@github.com:user/repo

# ssh:// protocol format
dreb install ssh://git@github.com/user/repo

# With version ref
dreb 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, dreb loads resources using package rules.

Creating a dreb Package

Add a dreb manifest to package.json or use conventional directories. Include the dreb-package keyword for discoverability.

{
  "name": "my-package",
  "keywords": ["dreb-package"],
  "dreb": {
    "extensions": ["./extensions"],
    "skills": ["./skills"],
    "prompts": ["./prompts"],
    "themes": ["./themes"]
  }
}

Paths are relative to the package root. Arrays support glob patterns and !exclusions.

Package Structure

Convention Directories

If no dreb manifest is present, dreb 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 dreb installs a package from npm or git, it runs npm install, so those dependencies are installed automatically.

dreb 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: @dreb/ai, @dreb/agent-core, @dreb/coding-agent, @dreb/tui, @sinclair/typebox.

Other dreb packages must be bundled in your tarball. Add them to dependencies and bundledDependencies, then reference their resources through node_modules/ paths. dreb loads packages with separate module roots, so separate installs do not collide or share modules.

Example:

{
  "dependencies": {
    "my-other-package": "^1.0.1"
  },
  "bundledDependencies": ["my-other-package"],
  "dreb": {
    "extensions": ["extensions", "node_modules/my-other-package/extensions"],
    "skills": ["skills", "node_modules/my-other-package/skills"]
  }
}

Package Filtering

Filter what a package loads using the object form in settings:

{
  "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 dreb config to enable or disable extensions, skills, prompt templates, and themes from installed packages and local directories. Works for both global (~/.dreb/agent) and project (.dreb/) scopes.

Scope and Deduplication

Packages can appear in both global and project settings. If the same package appears in both, the project entry wins. Identity is determined by:

  • npm: package name
  • git: repository URL without ref
  • local: resolved absolute path