extension-installer

Installing Freshell Extensions

When to Use

Use this skill when a user wants to:

• Add a new pane type to Freshell (from GitHub, a local project, or from scratch)
• Create a custom extension (server, client, or CLI)
• Debug why an installed extension isn't showing up

Do NOT use for modifying built-in pane types (terminal, browser, picker, etc.).

Critical Facts

Read this box before doing anything. These are the non-obvious rules that cause silent failures.

1. Extensions must be pre-built. Freshell does NOT run npm install, npm run build, or any build step. The extension directory must contain ready-to-run artifacts before symlinking.

2. Scan only on startup. Extensions are discovered once when the server starts. After installing or changing an extension, Freshell must be restarted.

3. z.strictObject rejects unknown keys. The manifest schema uses strict validation. Any key not in the schema (typos, extra fields) causes the entire manifest to silently fail validation and the extension is skipped. Check server logs for warnings.

4. Exactly one category config block. The manifest must have exactly one of client, server, or cli — and it must match the category field. Having zero, two, or a mismatched block fails validation.

5. Symlinks are the recommended dev pattern. The scanner follows symlinks. Point ~/.freshell/extensions/<name> at your project directory for development.

6. Template interpolation in server.env. Values support {{port}} (allocated port) and {{varName}} (contentSchema field defaults). Unresolved templates are left as-is.

7. ~/ expands to homedir. After template interpolation, env values starting with ~/ are expanded to the user's home directory.

8. Two scan directories. Freshell scans ~/.freshell/extensions/ (user-installed) and .freshell/extensions/ (local dev, relative to cwd). First match wins for duplicate names.

Category Decision Tree

Manifest Reference

All fields below are derived from the Zod schema in server/extension-manifest.ts. Use only these keys — any others cause silent rejection.

Top-level fields

contentSchema fields

Each key in contentSchema maps to a field descriptor:

picker fields

client config

server config

cli config

Copy-paste templates

Server extension:

{
  "name": "my-server-ext",
  "version": "0.1.0",
  "label": "My Server Extension",
  "description": "Does a thing with a server",
  "category": "server",
  "server": {
    "command": "node",
    "args": ["dist/index.js"],
    "env": {
      "PORT": "{{port}}"
    },
    "readyPattern": "listening on"
  }
}

Client extension:

{
  "name": "my-client-ext",
  "version": "0.1.0",
  "label": "My Client Extension",
  "description": "A static HTML pane",
  "category": "client",
  "client": {
    "entry": "index.html"
  }
}

CLI extension:

{
  "name": "my-cli-ext",
  "version": "0.1.0",
  "label": "My CLI Extension",
  "description": "Wraps a TUI tool",
  "category": "cli",
  "cli": {
    "command": "htop"
  }
}

Workflow: Install from GitHub/URL

1. Clone the repo to a local directory (e.g., ~/code/<name>).
2. Install dependencies — npm install (or equivalent for the project's stack).
3. Build — npm run build (or equivalent). Verify build artifacts exist (e.g., dist/).
4. Check for freshell.json in the project root.
   • If missing, create one. Examine the project to determine:
     • Category: Does it start a server? → server. Static HTML? → client. CLI tool? → cli.
     • Command: What starts the server or CLI? (e.g., node dist/index.js)
     • readyPattern: What does the server print to stdout when ready? (e.g., "listening on")
5. Validate the manifest mentally against the schema above — no extra keys, category block matches category field, required fields present.
6. Symlink into extensions directory:

   mkdir -p ~/.freshell/extensions
   ln -sf /absolute/path/to/extension ~/.freshell/extensions/<name>
   

   Use absolute paths — relative symlinks break when the working directory changes.
7. Restart Freshell for the extension to be discovered.
8. Verify — open the pane picker, confirm the extension appears, open it, confirm it works.

Workflow: Install from Local Directory

1. Check for freshell.json — if missing, create one (see manifest reference above).
2. Build if needed — check if the project requires a build step and run it.
3. Symlink:

   mkdir -p ~/.freshell/extensions
   ln -sf /absolute/path/to/project ~/.freshell/extensions/<name>
   

4. Restart Freshell.
5. Verify in the pane picker.

Workflow: Create from Scratch

Minimal server extension

Create a directory with two files:

index.js:

const http = require('http');
const port = process.env.PORT || 3000;
const server = http.createServer((req, res) => {
  res.writeHead(200, { 'Content-Type': 'text/html' });
  res.end('<h1>Hello from my extension</h1>');
});
server.listen(port, () => console.log(`Listening on port ${port}`));

freshell.json:

{
  "name": "hello-server",
  "version": "0.1.0",
  "label": "Hello Server",
  "description": "Minimal server extension example",
  "category": "server",
  "server": {
    "command": "node",
    "args": ["index.js"],
    "env": { "PORT": "{{port}}" },
    "readyPattern": "Listening on"
  }
}

No build step needed. Symlink and restart.

Single-file client extension

Create a directory with two files:

index.html:

<!DOCTYPE html>
<html>
<head><title>My Pane</title></head>
<body>
  <h1>Hello from a client extension</h1>
  <script>
    // Your pane logic here
  </script>
</body>
</html>

freshell.json:

{
  "name": "hello-client",
  "version": "0.1.0",
  "label": "Hello Client",
  "description": "Minimal client extension example",
  "category": "client",
  "client": {
    "entry": "index.html"
  }
}

No build step, no dependencies. Symlink and restart.

CLI wrapper

Just a manifest pointing at an existing binary. Single file:

freshell.json:

{
  "name": "htop-pane",
  "version": "0.1.0",
  "label": "htop",
  "description": "System monitor in a pane",
  "category": "cli",
  "cli": {
    "command": "htop"
  }
}

Create a directory with just this file, symlink, and restart.

Validation Checklist

Run through this before declaring an extension installed:

• freshell.json is valid JSON
• All 5 required top-level fields present (name, version, label, description, category)
• No unknown keys at any level (check typos — readypattern vs readyPattern)
• Exactly one category config block, matching category field
• contentSchema defaults match their declared type (string default for type: "string", etc.)
• Server: build artifact

Content truncated.