Skip to main content

Register an agent from a private repository

Jaah reads an agent's repository with your own GitHub connection, never a shared one. A private repository, or one in a GitHub organization, registers only when that connection can see it. Agents are registered from GitHub only. How the rest of registration works: How agents work.

Who can do this: anyone who may edit agents, with SDK agents on your plan.

  1. Connect a GitHub account that can read the repository, from your profile's Git section, as in Connect your GitHub, GitLab or other code host. For a repository in a GitHub organization, the Jaah GitHub App must be installed there: a warning on the Git section names each organization out of reach, with Install or request approval.
  2. In the sidebar, select Settings, then Agents under Customize, then the Custom agents tab, and select Add agent. The New agent page opens.
  3. Select Repository URL. It lists the repositories your GitHub connection reaches, grouped by owner, and reads Search or paste a URL. Type part of the name and pick the repository, or paste its address.
  4. Move to the next field and read the line under Repository URL:
    • Not available to your GitHub connection.: your connection can't see the repository. Fix its access (step 1), or reconnect the account from its ⋯ menu in the Git section after it joined a new organization. The Settings › Personal › Git link under the field opens that tab.
    • Couldn't read your GitHub repos, with the reason: Jaah could not list them. You can still paste the address; the reason says what to reconnect.
  5. In Sub-path, type the folder that holds the agent's manifest, such as agents/report-bot. Leave it empty when the manifest is at the repository root.
  6. In Ref, type the branch, tag or commit to use, such as main.
  7. Select Register. The page reads Fetching the repository and checking its manifest… for a few seconds.
  8. If Register is refused, read the problem listed above the buttons:
    • The repository did not answer — it is private to the GitHub account you connected, or it does not exist: your connection still can't see it. Fix access as in step 1, then select Register again.
    • Someone has not connected a GitHub account, or their connection names a credential that is no longer available: connect again from the Git section, then select Register again.
    • Anything about the manifest or the folder: fix it in the repository and push, as in Fix a custom agent whose refresh failed.
  9. Once registered, the agent's page opens. Check its mark reads Active, and that Facts under Details names the commit Jaah pinned.

Jaah keeps reading the repository, to pick up new pushes, with the GitHub connection of whoever registered the agent or last changed its Ref or Sub-path. If that person loses access or leaves your organization, the agent shows Last refresh failed. Someone with access changes its Ref or Sub-path and selects Save, and Jaah reads it as them from then on; see Change or remove a custom agent.