---
title: "Install a package from a GitHub repo"
method: POST
path: "/api/v1/install/github"
tags: ["Install"]
---

# Install a package from a GitHub repo

`POST /api/v1/install/github`

## Request

- Base URL: `https://api-docs.busabase.com`
- URL: `https://api-docs.busabase.com/api/v1/install/github`
- Auth: none declared

## Request body

- object
  - `repoUrl` string, required: GitHub repo URL: https://github.com/<owner>/<repo>[/tree/<ref>[/<subdir>]]. Only GitHub hosts are accepted.
  - `intoFolder` string: Slug of the folder to install into. Defaults to the package manifest's name.
  - `rename` boolean: Resolve slug collisions by suffixing (-2, -3, …) instead of refusing. Never overwrites anything.
  - `autoMerge` boolean: Whether the package's content change requests merge on the spot. Omitted defaults to merging immediately when the caller holds write access (installing is already a space owner/admin operation, so normally they do), otherwise leaving them for review; pass explicit false to force review even with write access. Either way, installing trusts the package author: a package can carry skills and AirApps, i.e. code this space's agents will execute.

## Response `200`

Created counts plus the number of change requests left for review. Structure (folders, Bases, fields, views) is created immediately — a pending Base has no id to attach a view or record to; content (records, docs, skills, AirApps) lands as change requests unless `autoMerge` is set.

- object
  - `targetFolderSlug` string, required
  - `targetFolderNodeId` string, required
  - `created` object, required
    - `folders` integer, required
    - `docs` integer, required
    - `bases` integer, required
    - `views` integer, required
    - `records` integer, required
    - `fileTreeNodes` integer, required
    - `files` integer, required
  - `pendingChangeRequests` integer, required
  - `warnings` string[]

---

[API](https://skmtc.dev/busabase/apis/busabase-api.md) · [All operations](https://skmtc.dev/busabase/apis/busabase-api/llms.txt) · [OpenAPI document](https://skmtc.dev/busabase/apis/busabase-api/revisions/bc6a7d5ff4c1?raw)
