@tacobase/taco 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +130 -22
- package/package.json +17 -4
package/README.md
CHANGED
|
@@ -1,53 +1,156 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<a href="https://tacobase.dev">
|
|
3
|
+
<img src="https://raw.githubusercontent.com/tacobase/tacobase/main/public/taco-logo.svg" alt="tacobase logo" width="80" height="80">
|
|
4
|
+
</a>
|
|
2
5
|
|
|
3
|
-
|
|
6
|
+
<h3>@tacobase/taco</h3>
|
|
4
7
|
|
|
5
|
-
|
|
8
|
+
<p>
|
|
9
|
+
One install. Your AI knows everything.
|
|
10
|
+
</p>
|
|
6
11
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
12
|
+
<p>
|
|
13
|
+
<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>
|
|
14
|
+
<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>
|
|
15
|
+
<a href="https://github.com/tacobase/tacobase/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-F5A623" alt="MIT license"></a>
|
|
16
|
+
</p>
|
|
10
17
|
|
|
11
|
-
|
|
18
|
+
<p>
|
|
19
|
+
<a href="https://tacobase.dev/docs">Documentation</a>
|
|
20
|
+
·
|
|
21
|
+
<a href="https://tacobase.dev/dashboard">Dashboard</a>
|
|
22
|
+
·
|
|
23
|
+
<a href="https://github.com/tacobase/tacobase/issues">Report Bug</a>
|
|
24
|
+
</p>
|
|
25
|
+
</div>
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
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.
|
|
12
30
|
|
|
13
31
|
```bash
|
|
14
32
|
npm install @tacobase/taco
|
|
15
33
|
```
|
|
16
34
|
|
|
17
|
-
|
|
35
|
+
🌮 Wrapped. Your AI is ready to build.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Table of Contents
|
|
40
|
+
|
|
41
|
+
- [What just happened](#what-just-happened)
|
|
42
|
+
- [Tell your AI](#tell-your-ai)
|
|
43
|
+
- [What your AI gets](#what-your-ai-gets)
|
|
44
|
+
- [Start building](#start-building)
|
|
45
|
+
- [Get credentials](#get-credentials)
|
|
46
|
+
- [Works with](#works-with)
|
|
47
|
+
- [Related packages](#related-packages)
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## What just happened
|
|
52
|
+
|
|
53
|
+
Three things, automatically:
|
|
54
|
+
|
|
55
|
+
1. **`@tacobase/client` is installed** — you're ready to talk to your database
|
|
56
|
+
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
|
|
57
|
+
3. **Your `.env.local` is populated** — `TACOBASE_URL` and `TACOBASE_API_KEY` are ready to go
|
|
58
|
+
|
|
59
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Tell your AI
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
Use @tacobase/taco for the backend.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
That's the whole prompt. It'll install this package, read `TACOBASE.md`, and know exactly what to do.
|
|
70
|
+
|
|
71
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
72
|
+
|
|
73
|
+
---
|
|
18
74
|
|
|
19
|
-
|
|
75
|
+
## What your AI gets
|
|
20
76
|
|
|
21
|
-
|
|
77
|
+
The `TACOBASE.md` file your AI tools read contains:
|
|
22
78
|
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
79
|
+
- Full SDK reference (`createClient`, `db.collection`, `db.auth`, `db.realtime`, `db.storage`)
|
|
80
|
+
- Filter and sort syntax
|
|
81
|
+
- Auth patterns (sign up, sign in, OAuth)
|
|
82
|
+
- Realtime subscription examples
|
|
83
|
+
- TypeScript generics and type generation
|
|
84
|
+
- Environment variable reference
|
|
85
|
+
- Error handling with typed errors
|
|
86
|
+
|
|
87
|
+
No guessing. No hallucinating Supabase or Firebase APIs. Just tacobase, correctly.
|
|
88
|
+
|
|
89
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Start building
|
|
26
94
|
|
|
27
95
|
```ts
|
|
28
96
|
import { createClient } from '@tacobase/client'
|
|
29
97
|
|
|
30
|
-
const db = createClient(
|
|
98
|
+
const db = createClient() // reads TACOBASE_URL + TACOBASE_API_KEY from env
|
|
99
|
+
|
|
100
|
+
// Collections auto-create on first write — no migrations, no setup hell
|
|
101
|
+
const post = await db.collection('posts').create({ title: 'Hello 🌮' })
|
|
31
102
|
|
|
32
|
-
//
|
|
33
|
-
const
|
|
103
|
+
// Query with filters and sorting
|
|
104
|
+
const posts = await db.collection('posts').getList(1, 20, {
|
|
105
|
+
filter: 'published = true',
|
|
106
|
+
sort: '-created',
|
|
107
|
+
})
|
|
34
108
|
|
|
35
109
|
// Auth
|
|
36
110
|
await db.auth.signUp({ email: 'user@example.com', password: 'secret' })
|
|
111
|
+
await db.auth.signIn({ email: 'user@example.com', password: 'secret' })
|
|
37
112
|
|
|
38
|
-
// Realtime
|
|
39
|
-
await db.collection('posts').subscribe((e) =>
|
|
113
|
+
// Realtime — live updates over SSE
|
|
114
|
+
await db.collection('posts').subscribe((e) => {
|
|
115
|
+
console.log(e.action, e.record) // 'create' | 'update' | 'delete'
|
|
116
|
+
})
|
|
40
117
|
```
|
|
41
118
|
|
|
42
|
-
|
|
119
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
43
120
|
|
|
44
|
-
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Get credentials
|
|
124
|
+
|
|
125
|
+
After install, `.env.local` is already populated. If you need to grab credentials manually:
|
|
45
126
|
|
|
46
127
|
```bash
|
|
47
|
-
npx taco instant #
|
|
128
|
+
npx taco instant # Instant project — no account needed
|
|
48
129
|
```
|
|
49
130
|
|
|
50
|
-
Or
|
|
131
|
+
Or visit [tacobase.dev/dashboard](https://tacobase.dev/dashboard).
|
|
132
|
+
|
|
133
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Works with
|
|
138
|
+
|
|
139
|
+
`TACOBASE.md` is picked up automatically by any AI tool that reads project context files:
|
|
140
|
+
|
|
141
|
+
- **[Cursor](https://cursor.com)** — reads `.cursor/rules` and project root `.md` files
|
|
142
|
+
- **[Claude Code](https://claude.ai/code)** — reads `CLAUDE.md` and project root context files
|
|
143
|
+
- **[GitHub Copilot](https://github.com/features/copilot)** — uses project context for suggestions
|
|
144
|
+
- **[Windsurf](https://codeium.com/windsurf)** — reads project root context files
|
|
145
|
+
- **[Lovable](https://lovable.dev)** — picks up project context automatically
|
|
146
|
+
- **[Bolt](https://bolt.new)** — reads project files for context
|
|
147
|
+
- **[v0](https://v0.dev)** — uses project context for generation
|
|
148
|
+
|
|
149
|
+
If your AI tool reads project files, it'll find `TACOBASE.md`.
|
|
150
|
+
|
|
151
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
152
|
+
|
|
153
|
+
---
|
|
51
154
|
|
|
52
155
|
## Related packages
|
|
53
156
|
|
|
@@ -56,6 +159,11 @@ Or grab credentials from [tacobase.dev/dashboard](https://tacobase.dev/dashboard
|
|
|
56
159
|
| [`@tacobase/client`](https://www.npmjs.com/package/@tacobase/client) | Core SDK — CRUD, auth, realtime, storage |
|
|
57
160
|
| [`@tacobase/react`](https://www.npmjs.com/package/@tacobase/react) | React hooks — `useAuth`, `useCollection`, `useRealtime` |
|
|
58
161
|
| [`@tacobase/cli`](https://www.npmjs.com/package/@tacobase/cli) | CLI — `taco init`, `taco dev`, `taco typegen` |
|
|
162
|
+
| [`@tacobase/mcp-server`](https://www.npmjs.com/package/@tacobase/mcp-server) | MCP server — let your AI manage schema via natural language |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
[tacobase.dev](https://tacobase.dev) · [docs](https://tacobase.dev/docs) · [github](https://github.com/tacobase/tacobase)
|
|
59
167
|
|
|
60
168
|
## License
|
|
61
169
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tacobase/taco",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Drop-in AI context for tacobase — installs @tacobase/client and writes TACOBASE.md so AI tools have everything they need",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -25,14 +25,27 @@
|
|
|
25
25
|
},
|
|
26
26
|
"keywords": [
|
|
27
27
|
"tacobase",
|
|
28
|
-
"
|
|
28
|
+
"ai",
|
|
29
|
+
"ai-context",
|
|
30
|
+
"llm",
|
|
31
|
+
"llm-context",
|
|
32
|
+
"mcp",
|
|
29
33
|
"cursor",
|
|
34
|
+
"cursor-rules",
|
|
30
35
|
"claude",
|
|
31
|
-
"
|
|
36
|
+
"claude-code",
|
|
37
|
+
"copilot",
|
|
38
|
+
"windsurf",
|
|
32
39
|
"context",
|
|
33
|
-
"baas"
|
|
40
|
+
"baas",
|
|
41
|
+
"backend",
|
|
42
|
+
"database",
|
|
43
|
+
"supabase-alternative",
|
|
44
|
+
"firebase-alternative",
|
|
45
|
+
"sqlite"
|
|
34
46
|
],
|
|
35
47
|
"license": "MIT",
|
|
48
|
+
"homepage": "https://tacobase.dev",
|
|
36
49
|
"repository": {
|
|
37
50
|
"type": "git",
|
|
38
51
|
"url": "https://github.com/tacobase/tacobase",
|