QM

https://github.com/yc-software/qm
Admin
QM is a multiplayer agent harness for startups that runs in Slack and on the web, giving employees...
Tokens:136,479
Snippets:2,172
Trust Score:6.8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Build and Run Commands

Source: https://github.com/yc-software/qm/blob/main/plugins/web-ui/README.md

Standard commands for installing dependencies, building the project, and starting the server.

```bash
npm install
npm run build
npm run serve

npm start
```

--------------------------------

### Install Design System Dependencies

Source: https://github.com/yc-software/qm/blob/main/skills-seed/taste-skill/references/tasteskill.md

Use these commands to install the required packages for various design systems or to initialize component libraries in your project.

```bash
# Material Web (Material 3)
npm install @material/web

# Fluent UI React (v9)
npm install @fluentui/react-components

# Fluent UI Web Components (framework-free)
npm install @fluentui/web-components @fluentui/tokens

# IBM Carbon
npm install @carbon/react @carbon/styles

# Radix Themes
npm install @radix-ui/themes

# shadcn/ui (open code, owned components)
npx shadcn@latest init
npx shadcn@latest add button card badge separator input

# Primer CSS (GitHub product/devtool UI)
npm install --save @primer/css

# Primer Brand (GitHub marketing UI)
npm install @primer/react-brand

# GOV.UK Frontend
npm install govuk-frontend

# USWDS (US Web Design System)
npm install uswds

# Atlassian Design System (Atlaskit)
yarn add @atlaskit/css-reset @atlaskit/tokens @atlaskit/button @atlaskit/badge @atlaskit/section-message @atlaskit/card

# Bootstrap 5.3
npm install bootstrap

# Shopify Polaris Web Components (Shopify apps only)
# Add this to your app HTML head:
#   <meta name="shopify-api-key" content="%SHOPIFY_API_KEY%" />
#   <script src="https://cdn.shopify.com/shopifycloud/polaris.js"></script>
```

--------------------------------

### Install dependencies reproducibly

Source: https://github.com/yc-software/qm/blob/main/cli/templates/deployment/deployment.md

Ensures consistent dependency installation by preferring npm ci if a lockfile exists, falling back to npm install otherwise.

```bash
test -f package-lock.json && npm ci || npm install
npm exec qm -- version
```

--------------------------------

### Initialize sandbox application

Source: https://github.com/yc-software/qm/blob/main/cli/templates/deployment/references/fly.md

Create the sandbox app and run the setup sequence to verify permissions and generate tokens.

```bash
fly apps create <sandbox-app> --org <fly-org>
npm exec qm -- setup .
npm exec qm -- slack render
npm exec qm -- check
```

--------------------------------

### Initialize QM deployment repository

Source: https://github.com/yc-software/qm/blob/main/README.md

Use this command to initialize a new organization-owned deployment repository and install necessary dependencies.

```bash
npm exec --yes --package=@yc-software/qm@latest -- \
  qm init . --org <slug> --target <fly-or-aws>
npm install
```

--------------------------------

### GET /healthz

Source: https://github.com/yc-software/qm/blob/main/plugins/auth/README.md

Liveness check for the service.

```APIDOC
## GET /healthz

### Description
Used by the platform to check service liveness.

### Method
GET

### Endpoint
/healthz
```

--------------------------------

### Initialize the deployment repository

Source: https://github.com/yc-software/qm/blob/main/cli/templates/deployment/deployment.md

Use this command to initialize a new repository with the QM CLI, specifying the organization slug, hosting target, and model provider.

```bash
npm exec --yes --package=@yc-software/qm@latest -- \
  qm init . --org <slug> --target <fly-or-aws> --model-provider <provider>
npm install
```

--------------------------------

### Run and test portal plugin

Source: https://github.com/yc-software/qm/blob/main/plugins/portal/README.md

Use these commands to start the development server, verify type safety, and execute the test suite.

```bash
npm start
npm run typecheck
npm test
```

--------------------------------

### GET /v1/admin/crons|deployments|skills

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

List artifacts by owner.

```APIDOC
## GET /v1/admin/crons|deployments|skills

### Description
Lists artifacts (crons, deployments, or skills) by owner.

### Method
GET

### Endpoint
/v1/admin/crons|deployments|skills

### Parameters
#### Query Parameters
- **scope** (string) - Optional - Filter by scope.
```

--------------------------------

### Run Development Server

Source: https://github.com/yc-software/qm/blob/main/skills-seed/taste-skill/SKILL.md

Command to start a local development server for previewing the artifact.

```bash
PORT=8080 node server.js
```

--------------------------------

### GET /v1/admin/sessions

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

List conversation sessions.

```APIDOC
## GET /v1/admin/sessions

### Description
Returns a listing of conversations including turns and last activity.

### Method
GET

### Endpoint
/v1/admin/sessions

### Parameters
#### Query Parameters
- **scope** (string) - Optional - Filter by scope.
- **limit** (integer) - Optional - Limit the number of results.
- **offset** (integer) - Optional - Offset for pagination.
```

--------------------------------

### GET /.well-known/openid-configuration

Source: https://github.com/yc-software/qm/blob/main/plugins/auth/README.md

Provides OIDC discovery configuration.

```APIDOC
## GET /.well-known/openid-configuration

### Description
Returns the OIDC discovery configuration for debugging purposes.

### Method
GET

### Endpoint
/.well-known/openid-configuration
```

--------------------------------

### QM CLI Deployment Workflow

Source: https://github.com/yc-software/qm/blob/main/cli/README.md

Standard sequence of commands to initialize a project, verify infrastructure, and deploy services using the QM CLI.

```bash
npm exec --yes --package=@yc-software/qm@latest -- \
  qm init . --org acme --target aws
npm install
npm exec qm -- check
npm exec qm -- infra render
npm exec qm -- doctor
npm exec qm -- infra build-image
npm exec qm -- plan
npm exec qm -- up --yes
npm exec qm -- check --live
```

--------------------------------

### Initialize and deploy Fly sandbox base image

Source: https://github.com/yc-software/qm/blob/main/fly/README.md

Commands to install flyctl, authenticate, create the sandbox application, and deploy the base image.

```bash
brew install flyctl
fly auth login
export FLY_SANDBOX_APP_NAME=<operator-owned-sandbox-app>
fly apps create "$FLY_SANDBOX_APP_NAME" --org <fly-org>
npm run deploy:fly-image
```

--------------------------------

### GET /v1/profiles

Source: https://github.com/yc-software/qm/blob/main/skills-seed/browse/providers/anchor.md

Lists all available browser profiles.

```APIDOC
## GET /v1/profiles

### Description
Lists all browser profiles associated with the account.

### Method
GET

### Endpoint
https://api.anchorbrowser.io/v1/profiles
```

--------------------------------

### GET /v1/admin/retention

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

Retrieves system retention settings.

```APIDOC
## GET /v1/admin/retention

### Description
Retrieves the current system retention settings.

### Method
GET

### Endpoint
/v1/admin/retention
```

--------------------------------

### Configure the core application

Source: https://github.com/yc-software/qm/blob/main/fly/README.md

Use these environment variables to set up the deployment token, sandbox app name, base image, and region when starting the application.

```bash
FLY_API_TOKEN="$(fly tokens create deploy -a "$FLY_SANDBOX_APP_NAME")" \
FLY_SANDBOX_APP_NAME="$FLY_SANDBOX_APP_NAME" \
FLY_BASE_IMAGE="registry.fly.io/$FLY_SANDBOX_APP_NAME@sha256:<digest>" \
FLY_REGION=sjc \
npm start
```

--------------------------------

### Verify deployment and infrastructure

Source: https://github.com/yc-software/qm/blob/main/cli/templates/deployment/deployment.md

Run these commands to check provider infrastructure, verify conformance, and retrieve deployment outputs in JSON format.

```bash
npm exec qm -- check --live
npm exec qm -- conformance
npm exec qm -- outputs --json
```

--------------------------------

### GET /v1/admin/volumes

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

List volume contents for a scope.

```APIDOC
## GET /v1/admin/volumes

### Description
Lists a scope's computer/backup contents (sizes only).

### Method
GET

### Endpoint
/v1/admin/volumes

### Parameters
#### Query Parameters
- **scope** (string) - Optional - Filter by scope.
```

--------------------------------

### GET /v1/admin/files

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

List files in the document store.

```APIDOC
## GET /v1/admin/files

### Description
Lists files in the document store for a given scope.

### Method
GET

### Endpoint
/v1/admin/files

### Parameters
#### Query Parameters
- **scope** (string) - Optional - Filter by scope.
```

--------------------------------

### Publish an application

Source: https://github.com/yc-software/qm/blob/main/skills-seed/publish/SKILL.md

Deploys an application with a specified directory, entrypoint, and name.

```javascript
publish({ dir: "dist", entrypoint: "node server.js", name: "status-board" })
```

--------------------------------

### GET /v1/admin/runs

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

List recent or in-flight runs.

```APIDOC
## GET /v1/admin/runs

### Description
Lists queued, in-flight, or recent runs.

### Method
GET

### Endpoint
/v1/admin/runs

### Parameters
#### Query Parameters
- **scope** (string) - Optional - Filter by scope.
```

--------------------------------

### Create a browser session with a profile

Source: https://github.com/yc-software/qm/blob/main/skills-seed/browse/providers/anchor.md

Initialize a session using a specific profile name and extract the CDP URL, session ID, and live view URL.

```bash
CREATE=$(curl -fsS -X POST https://api.anchorbrowser.io/v1/sessions \
  -H "anchor-api-key: $ANCHOR_API_KEY" -H 'content-type: application/json' \
  -d "{\"session\":{\"timeout\":{\"max_duration\":30,\"idle_timeout\":10}},\"browser\":{\"profile\":{\"name\":\"$ANCHOR_PROFILE\"}}}")
CDP_URL=$(printf '%s' "$CREATE" | python3 -c "import sys,json;print(json.load(sys.stdin)['data'].get('cdp_url',''))")
ANCHOR_SID=$(printf '%s' "$CREATE" | python3 -c "import sys,json;print(json.load(sys.stdin)['data'].get('id',''))")
LIVE_VIEW=$(printf '%s' "$CREATE" | python3 -c "import sys,json;print(json.load(sys.stdin)['data'].get('live_view_url',''))")
```

--------------------------------

### GET /.well-known/jwks.json

Source: https://github.com/yc-software/qm/blob/main/plugins/auth/README.md

Retrieves the public keys for token verification.

```APIDOC
## GET /.well-known/jwks.json

### Description
Provides the ES256 public key for verifying tokens.

### Method
GET

### Endpoint
/.well-known/jwks.json
```

--------------------------------

### GET /v1/admin/egress

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

Retrieves egress data for a specified scope.

```APIDOC
## GET /v1/admin/egress

### Description
Retrieves egress data for the provided scope.

### Method
GET

### Endpoint
/v1/admin/egress

### Parameters
#### Query Parameters
- **scope** (string) - Required - The scope for which to retrieve egress data.
```

--------------------------------

### Create and initialize a private fork

Source: https://github.com/yc-software/qm/blob/main/README.md

Commands to create a private repository and initialize it with the QM codebase using a bare clone to avoid GitHub's fork limitations.

```bash
gh repo create <org>/qm-private --private

git clone --bare git@github.com:yc-software/qm qm-seed.git
git -C qm-seed.git push --mirror git@github.com:<org>/qm-private
rm -rf qm-seed.git

git clone git@github.com:<org>/qm-private
git -C qm-private remote add upstream git@github.com:yc-software/qm
```

--------------------------------

### GET /v1/admin/metrics

Source: https://github.com/yc-software/qm/blob/main/skills-seed/admin/SKILL.md

Retrieves system metrics for a specified scope.

```APIDOC
## GET /v1/admin/metrics

### Description
Retrieves system metrics for the provided scope.

### Method
GET

### Endpoint
/v1/admin/metrics

### Parameters
#### Query Parameters
- **scope** (string) - Required - The scope for which to retrieve metrics.
```
Tokens:
Raw