npm package: @tacobase/taco
Description: Drop-in AI context for tacobase — installs @tacobase/client and writes TACOBASE.md so AI tools have everything they need
Latest version: 0.1.5

<div align="center">
  <a href="https://tacobase.dev">
    <img src="https://www.tacobase.dev/taco-logo.svg" alt="tacobase logo" width="80" height="80">
  </a>

  <h3>@tacobase/taco</h3>

  <p>
    One install. Your AI knows everything.
  </p>

  <p>
    <a href="https://www.npmjs.com/package/@tacobase/taco"><img src="https://img.shields.io/npm/v/@tacobase/taco?color=F5A623&label=npm" alt="npm version"></a>
    <a href="https://www.npmjs.com/package/@tacobase/taco"><img src="https://img.shields.io/npm/dm/@tacobase/taco?color=F5A623" alt="npm downloads"></a>
    <a href="https://github.com/tacobase/tacobase/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-F5A623" alt="MIT license"></a>
  </p>

  <p>
    <a href="https://tacobase.dev/docs">Documentation</a>
    ·
    <a href="https://tacobase.dev/dashboard">Dashboard</a>
    ·
    <a href="https://github.com/tacobase/tacobase/issues">Report Bug</a>
  </p>
</div>

---

Install this package and your AI tools — Cursor, Claude Code, GitHub Copilot, Windsurf, Lovable, Bolt, v0, and more — instantly know how to use tacobase. No copy-pasting docs. No prompt engineering. No context switching.

```bash
npm install @tacobase/taco
```

🌮 Wrapped. Your AI is ready to build.

---

## Table of Contents

- [What just happened](#what-just-happened)
- [Tell your AI](#tell-your-ai)
- [What your AI gets](#what-your-ai-gets)
- [Start building](#start-building)
- [Get credentials](#get-credentials)
- [Works with](#works-with)
- [Related packages](#related-packages)

---

## What just happened

Three things, automatically:

1. **`@tacobase/client` is installed** — you're ready to talk to your database
2. **`TACOBASE.md` is written to your project root** — Cursor, Claude Code, Copilot, Windsurf, Lovable, Bolt, v0, and other AI tools pick it up automatically with the full tacobase API, filter syntax, auth patterns, and more
3. **Your `.env.local` is populated** — `TACOBASE_URL` and `TACOBASE_API_KEY` are ready to go

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Tell your AI

```
Use @tacobase/taco for the backend.
```

That's the whole prompt. It'll install this package, read `TACOBASE.md`, and know exactly what to do.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## What your AI gets

The `TACOBASE.md` file your AI tools read contains:

- Full SDK reference (`createClient`, `db.collection`, `db.auth`, `db.realtime`, `db.storage`)
- Filter and sort syntax
- Auth patterns (sign up, sign in, OAuth)
- Realtime subscription examples
- TypeScript generics and type generation
- Environment variable reference
- Error handling with typed errors

No guessing. No hallucinating Supabase or Firebase APIs. Just tacobase, correctly.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Start building

```ts
import { createClient } from '@tacobase/client'

const db = createClient() // reads TACOBASE_URL + TACOBASE_API_KEY from env

// Collections auto-create on first write — no migrations, no setup hell
const post = await db.collection('posts').create({ title: 'Hello 🌮' })

// Query with filters and sorting
const posts = await db.collection('posts').getList(1, 20, {
  filter: 'published = true',
  sort: '-created',
})

// Auth
await db.auth.signUp({ email: 'user@example.com', password: 'secret' })
await db.auth.signIn({ email: 'user@example.com', password: 'secret' })

// Realtime — live updates over SSE
await db.collection('posts').subscribe((e) => {
  console.log(e.action, e.record) // 'create' | 'update' | 'delete'
})
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Get credentials

After install, `.env.local` is already populated. If you need to grab credentials manually:

```bash
npx taco instant   # Instant project — no account needed
```

Or visit [tacobase.dev/dashboard](https://tacobase.dev/dashboard).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Works with

`TACOBASE.md` is picked up automatically by any AI tool that reads project context files:

- **[Cursor](https://cursor.com)** — reads `.cursor/rules` and project root `.md` files
- **[Claude Code](https://claude.ai/code)** — reads `CLAUDE.md` and project root context files
- **[GitHub Copilot](https://github.com/features/copilot)** — uses project context for suggestions
- **[Windsurf](https://codeium.com/windsurf)** — reads project root context files
- **[Lovable](https://lovable.dev)** — picks up project context automatically
- **[Bolt](https://bolt.new)** — reads project files for context
- **[v0](https://v0.dev)** — uses project context for generation

If your AI tool reads project files, it'll find `TACOBASE.md`.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Related packages

| Package | Description |
|---|---|
| [`@tacobase/client`](https://www.npmjs.com/package/@tacobase/client) | Core SDK — CRUD, auth, realtime, storage |
| [`@tacobase/react`](https://www.npmjs.com/package/@tacobase/react) | React hooks — `useAuth`, `useCollection`, `useRealtime` |
| [`@tacobase/cli`](https://www.npmjs.com/package/@tacobase/cli) | CLI — `taco init`, `taco dev`, `taco typegen` |
| [`@tacobase/mcp-server`](https://www.npmjs.com/package/@tacobase/mcp-server) | MCP server — let your AI manage schema via natural language |

---

[tacobase.dev](https://tacobase.dev) · [docs](https://tacobase.dev/docs) · [github](https://github.com/tacobase/tacobase)

## License

MIT