> ## Documentation Index
> Fetch the complete documentation index at: https://docs.budscollab.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Build and validate a BudsCollab app artifact from your own repo.

Build a BudsCollab app artifact in your own repo, validate it locally, and
create the review evidence needed before the app can move toward registry
review.

The public SDK has one core loop:

1. Scaffold an app repo.
2. Compile `budscollab.blueprint.json` into `budscollab.package.json`.
3. Validate the package.
4. Generate review and plugin-package evidence.

## Create an app

```bash theme={null}
npm create budscollab-app my-app -- --name "My App"
cd my-app
pnpm run build:budscollab-artifact
pnpm run validate:budscollab-artifact
pnpm run verify:budscollab-plugin
```

After the commands finish, the repo should contain:

| Artifact                                     | Purpose                                                        |
| -------------------------------------------- | -------------------------------------------------------------- |
| `budscollab.blueprint.json`                  | Editable app source for surfaces, capabilities, and metadata.  |
| `budscollab.package.json`                    | Strict package artifact used by validation and review.         |
| `budscollab-app-review.json`                 | Review evidence and any remaining install blockers.            |
| `budscollab-showcase.json` and `SHOWCASE.md` | Preview metadata for humans and agents.                        |
| `.budscollab/plugin-package.json`            | App-local agent/package wrapper tied to the same SDK artifact. |

`verify:budscollab-plugin` checks the app-local wrapper. It does not install the
app and it does not make a marketplace claim.

## Keep CI aligned

For CI, keep the generated `.github/workflows/budscollab-sdk.yml` and run:

```bash theme={null}
pnpm run ci:budscollab
```

That command runs the same artifact validation and plugin-package verification
path that local developers, Eve sandbox jobs, and coding agents should use.

## Choose a build lane

| Goal                                                       | Start here                                                 |
| ---------------------------------------------------------- | ---------------------------------------------------------- |
| Compact canvas object or chat output                       | [Create a widget](/build/create-a-widget)                  |
| Multi-surface app with fullscreen and dock                 | [Create a full app](/build/create-a-full-app)              |
| Agent-friendly package with skills, docs, and optional MCP | [Create a plugin package](/build/create-a-plugin-package)  |
| Understand the underlying model first                      | [Safely composable apps](/concepts/safely-composable-apps) |