Publishing an Extension

Publishing your extension makes it available to all ted users via the marketplace and the ted ext install command.

Overview

The extensions registry is a GitHub repository. Publishing is done via a Pull Request — no accounts or tokens required beyond a GitHub account.

Step 1: Fork the Registry

Go to github.com/ted-industries/extensions and click Fork.

Clone your fork locally:

git clone https://github.com/<your-username>/extensions
cd extensions

Step 2: Add Your Extension

Create a new folder under registry/extensions/<your-extension-name>/:

registry/
└── extensions/
    └── your-extension-name/
        ├── package.json   # Required
        ├── index.js       # Required (must match "main" field)
        ├── README.md      # Recommended
        └── icon.png       # Optional — 128×128 PNG

package.json Requirements

Your package.json must include these fields:

{
  "name": "your-extension-name",
  "displayName": "Your Extension",
  "description": "A short description of what your extension does",
  "version": "1.0.0",
  "main": "index.js",
  "author": "your-github-username",
  "repository": "https://github.com/your-username/your-extension-repo",
  "tags": ["productivity", "utility"]
}

Step 3: Validate Locally

Run the validator before opening a PR:

# From the repo root
bun scripts/validate.ts

All checks must pass:

• ✓ Required fields present
• ✓ Extension name matches folder name
• ✓ main file exists
• ✓ No duplicate extension names
• ✓ Valid semver version

Step 4: Open a Pull Request

git add registry/extensions/your-extension-name/
git commit -m "feat: add your-extension-name extension"
git push origin main

Then open a Pull Request against ted-industries/extensions. The CI workflow will automatically run the validator on your PR.

Step 5: After Merge

Once your PR is merged:

1. The build-index.ts script rebuilds registry/extensions.json
2. The marketplace website rebuilds and shows your extension
3. Users can install it with:

ted ext install your-extension-name

Extension Quality Guidelines

• Keep it focused — one extension, one purpose
• Handle errors gracefully — catch all async errors
• Avoid global state — clean up in deactivate()
• Test locally before submitting — copy your folder to ~/.ted/extensions/ and restart ted

Updating Your Extension

To publish a new version:

1. Bump the version field in package.json (semver)
2. Update README.md with a changelog entry
3. Open a new PR with your changes