Quickstart

1. Register

Create an account and get an API key. You can register via the API or the CLI.

# Via the API
curl -X POST https://api.graspful.ai/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"..."}'
# → { "apiKey": "gsk_...", "orgSlug": "you-example" }

# Or via the CLI
graspful register --email you@example.com --password "..."

The CLI saves your credentials automatically so you can skip the login step.

2. Import a course

Import a course YAML into your org. Use the API directly or the CLI.

# Via the API
curl -X POST https://api.graspful.ai/api/v1/orgs/you-example/courses/import \
  -H "Authorization: Bearer gsk_..." \
  -H "Content-Type: application/json" \
  -d '{"yaml": "..."}'

# Or via the CLI
graspful import course.yaml --org you-example

3. Your course is live!

Visit your org subdomain to see it in action.

# Your course is live at:
https://you-example.graspful.com

Full authoring workflow

If you want to create a course from scratch, the CLI provides the full scaffold-fill-review-import pipeline.

A. Install the CLI

Install globally with bun or use npx to run without installing.

# Install globally
bun add -g @graspful/cli

# Or run without installing
npx @graspful/cli

B. Scaffold a course

Generate the knowledge graph skeleton — sections, concepts, and prerequisite edges. No learning content yet, just the structure.

graspful create course \
  --scaffold-only \
  --topic "AWS Solutions Architect" \
  --source "AWS SAA-C03 Exam Guide" \
  --hours 40 \
  -o aws-saa-c03.yaml

Edit the generated YAML to add more concepts, adjust prerequisites, set difficulty levels (1-10), and group concepts into sections.

C. Fill concepts

Add knowledge points and practice problems to each concept. The CLI generates stubs with TODO placeholders that you replace with real content.

# Fill one concept at a time
graspful fill concept aws-saa-c03.yaml aws-saa-c03-intro

# Customize stub count
graspful fill concept aws-saa-c03.yaml vpc-basics --kps 3 --problems 4

Each knowledge point stub includes instruction text, a worked example, and multiple-choice problems with a difficulty staircase. Replace the TODO placeholders with real content before reviewing.

D. Review

Run all 10 mechanical quality checks. Fix any failures before publishing.

graspful review aws-saa-c03.yaml

The review gate checks for duplicate questions, difficulty staircase violations, missing worked examples, invalid prerequisites, and more. A score of 10/10 is required to publish. See the Review Gate docs for details on each check.

E. Import and publish

Import the course YAML to the platform. Use --publish to publish immediately (runs the review gate server-side).

# Import as draft
graspful import aws-saa-c03.yaml --org my-org

# Import and publish in one step
graspful import aws-saa-c03.yaml --org my-org --publish

F. Create a brand

Generate a brand YAML to configure the landing page, theme, pricing, and SEO. Then import it to launch a white-label product.

# Scaffold a brand
graspful create brand \
  --niche tech \
  --name "AWS Prep Academy" \
  --domain aws-prep.graspful.com \
  --org my-org \
  -o aws-prep-brand.yaml

# Import the brand
graspful import aws-prep-brand.yaml