Docs article

Getting Started

Install the workspace, initialize a contract, and run your first validation + lint flow.

Getting Started#

1. Install#

pnpm install
pnpm build

2. Initialize in your app repo#

tastekernel init --yes

Generated files:

  • tastekernel.contract.yml
  • .tastekernelignore
  • .github/workflows/tastekernel.yml

3. Validate + lint + fix#

tastekernel validate
tastekernel lint --format stylish
tastekernel fix --dry-run

4. Cloud login + publish + pull#

tastekernel login --api-url https://tastekernel.com
tastekernel publish --project-id <project-slug>
tastekernel pull-contract --project-id <project-slug>

5. CI modes#

  • Local mode: repo-local contract is used
  • Cloud mode: set TASTEKERNEL_MODE=cloud, TASTEKERNEL_PROJECT_ID, TASTEKERNEL_API_KEY

6. Verification checklist#

  • pnpm build
  • pnpm typecheck
  • pnpm test
  • pnpm --filter @tastekernel/web test:smoke:list