Getting started

Hand-written guide. Commands below are copied from tested snippet files under prose/guides/snippets/.

Who this is forCopy Anchor Link

You ship TypeScript apps (often React admin UIs, APIs, or content sites) and want small, versioned packages instead of copying utilities from blog posts. You are fine installing from npm and reading one catalog page when you know which need you have.

When to use zedkitCopy Anchor Link

Use zedkit when a documented need matches yours: the catalog lists imports, maturity, and examples that stay aligned with the published package. Prefer your own code when the need is highly specific to one product and will not be reused.

Reach for a thin wrapper around a mature npm library when zedkit does not list the need yet (see the golden rule in the repo).

Using shadcn/ui today? Read zedkit and shadcn/ui for what the UI kit wraps, registry install vs npm, and when to stay on upstream shadcn.

Choose a packageCopy Anchor Link

Install only the packages you need. The docs index groups every catalog entry under these folders.

PrerequisitesCopy Anchor Link

• Node.js 22 or newer and pnpm 9 (same as the root README quickstart).
• UI work: React 19 and Tailwind CSS v4 in your app; follow the theme doc for tokens and the .dark class.
• Agent setup: a git repo on your machine; pick one provider flag for zedkit-ai init (cursor, claude, codex, muse, or all).

QuickstartCopy Anchor Link

Pick one path. Both end with something you can see or verify in the terminal.

Path A — coding agents (about two minutes)Copy Anchor Link

In your repo root:

pnpm add -D @zedtech/zedkit-ai
npx zedkit-ai init . --provider cursor

Ask your agent to run the setup-ai skill (it fills AGENTS.md from repo facts). Then:

npx zedkit-ai validate

First result: the validate command prints ok. If it does not, see Troubleshooting.

Path B — admin UI button (install only on this page)Copy Anchor Link

In your app:

pnpm add @zedtech/zedkit-ui

Wire Tailwind and theme tokens using Theme an admin app, then render a button:

import { Button } from "@zedtech/zedkit-ui";

export function SaveRow() {
  return (
    <>
      <Button>Save</Button>
      <Button variant="destructive" size="sm">Delete</Button>
    </>
  );
}

First result: a styled Save button in your running app. Open Button for variants, registry install, and the live preview.

ScenarioCopy Anchor Link

You inherit a monorepo with no agent instructions. You only need consistent skills for Cursor today.

1. Run Path A with --provider cursor.
2. Open the AI setup catalog page and run validate from the install tabs if you prefer copy from there.
3. Commit the files init created; re-run validate after you edit skills.

Next, add UI only when you start an admin screen — install @zedtech/zedkit-ui then, not on day one.

TroubleshootingCopy Anchor Link

Next stepsCopy Anchor Link

• Catalog depth: pick a need from the docs index four areas; every need page has install tabs and a usage example.
• Tutorials: longer walkthroughs (admin dashboard, agent setup, Nest API, Next.js SEO) are added as separate docs pages — start from the catalog links above until those guides ship.
• Machine-readable index: public/llms.txt lists the same URLs for agents.