Skip to content

Repository files navigation

shell-framework

OpenShellOrg modular extension host — manifests, discovery, and registration for shell extensions. This repository implements the host stub that loads extension manifests and registers core and user-supplied extensions.

Dual-repo model

OpenShellOrg splits architecture from implementation:

Repository Role
shell-architecture Canon — thesis, Tool Runs, command channels, Antora docs, diagrams
shell-framework (this repo) Extension host — manifest schema, core extension registry, discovery, host APIs

Do not duplicate architecture docs here. When you need design rationale (structured pipelines, SOS relationship, host identity, env refresh plans), use shell-architecture.

What lives here

  • manifests/core/ — pointers to first-party core extensions (repos/packages), not vendored source
  • src/ — TypeScript extension host: load manifests, register extensions, discover bundled core set
  • Tests + CI — build and verify core registration (e.g. Prohelp) without cloning extension repos

Core extensions

Core extensions are registered by manifest only. The host does not embed their code.

Extension Manifest Upstream
Prohelp manifests/core/prohelp.manifest.json openshellorg/prohelp · CLI: prohelp-cli

Quick start

pnpm install
pnpm build
pnpm test

Programmatic bootstrap:

import { bootstrapExtensionHost } from "@openshellorg/shell-framework";

const host = await bootstrapExtensionHost();
console.log(host.listCore()); // includes openshellorg/prohelp

See CONTRIBUTING.md for layout and manifest conventions.

Related projects

  • shell-architecture — canon docs
  • prohelp — structured help / gutter tooling (first core extension)
  • docs — SOS certification and org docs site

License

MIT — see LICENSE.

About

OpenShellOrg shell framework: modular extension host (Prohelp and surfaces plug in; canon lives in shell-architecture)

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages