Skip to main content

Plugin launcher

The Faheem Code Cloud https://app.faheemcode.ai/launch route lets you create shareable links that open Faheem Code with one or more plugins already selected.

This is useful for:

  • adding a "Try it" link or badge to a plugin README
  • sharing a pre-configured plugin in docs, issues, or Slack
  • building internal test pages for plugin development

Before you start​

You will need:

  • an Faheem Code Cloud account
  • a plugin or skill stored in a Git repository
  • the repository source, and optionally a branch/tag/commit and subdirectory path

Step 1: define the plugin​

Create a JSON array of plugin definitions. Each item uses this shape:

[
  {
    "source": "github:SMART-National-Solution/faheem-code-extensions",
    "ref": "main",
    "repo_path": "plugins/pr-review"
  }
]

The fields are:

  • source - where the plugin lives, such as github:owner/repo or a Git URL
  • ref - optional branch, tag, or commit
  • repo_path - optional subdirectory inside the repository
  • parameters - optional configuration values that Faheem Code shows as editable inputs before launch

Step 2: encode the plugin definition​

The plugins query parameter must be a base64-encoded version of your JSON array.

[
  {
    "source": "github:SMART-National-Solution/faheem-code-extensions",
    "ref": "main",
    "repo_path": "plugins/pr-review"
  }
]

Convert that JSON into base64-encoded text, then use the encoded value as the plugins query parameter in your /launch URL.

Step 3: add an optional starting message​

If you want the launched conversation to start with a prompt, add a message query parameter.

https://app.faheemcode.ai/launch?plugins=W3sic291cmNlIjoiZ2l0aHViOk9wZW5IYW5kcy9leHRlbnNpb25zIiwicmVmIjoibWFpbiIsInJlcG9fcGF0aCI6InBsdWdpbnMvcHItcmV2aWV3In1d&message=/pr-review%20https%3A//github.com/SMART-National-Solution/faheem-code-app/pull/12699

In this example:

  • plugins loads the pr-review plugin from SMART-National-Solution/faheem-code-extensions
  • message pre-fills the initial task for the conversation

Step 4: open the launch URL​

When someone opens the link in Faheem Code Cloud:

  1. They sign in if needed.
  2. Faheem Code shows the plugins or skills from the URL.
  3. Any parameters values are shown as inputs that the user can review or edit.
  4. The user confirms they trust the extension.
  5. Faheem Code starts the conversation with the selected plugin configuration.

Simple format for development​

For quick local or staging tests, you can use simpler query parameters instead of base64 encoding:

https://app.faheemcode.ai/launch?plugin_source=github:SMART-National-Solution/faheem-code-extensions&plugin_ref=main&plugin_repo_path=plugins/pr-review

This format is convenient for manual testing, but the encoded plugins format is better for production links because it also supports multiple plugins in one URL.

Next steps​