zilmate 1.8.1 → 1.9.1
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/.agents/skills/copywriting/SKILL.md +252 -0
- package/.agents/skills/copywriting/evals/evals.json +111 -0
- package/.agents/skills/copywriting/references/copy-frameworks.md +344 -0
- package/.agents/skills/copywriting/references/natural-transitions.md +272 -0
- package/.agents/skills/firecrawl-deep-research/SKILL.md +108 -0
- package/.agents/skills/shadcn/SKILL.md +267 -0
- package/.agents/skills/shadcn/agents/openai.yml +5 -0
- package/.agents/skills/shadcn/assets/shadcn-small.png +0 -0
- package/.agents/skills/shadcn/assets/shadcn.png +0 -0
- package/.agents/skills/shadcn/cli.md +290 -0
- package/.agents/skills/shadcn/customization.md +209 -0
- package/.agents/skills/shadcn/evals/evals.json +47 -0
- package/.agents/skills/shadcn/mcp.md +105 -0
- package/.agents/skills/shadcn/registry.md +277 -0
- package/.agents/skills/shadcn/rules/base-vs-radix.md +306 -0
- package/.agents/skills/shadcn/rules/composition.md +195 -0
- package/.agents/skills/shadcn/rules/forms.md +192 -0
- package/.agents/skills/shadcn/rules/icons.md +101 -0
- package/.agents/skills/shadcn/rules/styling.md +162 -0
- package/.agents/skills/tavily-research/SKILL.md +100 -0
- package/.agents/skills/upstash/SKILL.md +48 -0
- package/.agents/skills/upstash/upstash-box-js/overview.md +243 -0
- package/.agents/skills/upstash/upstash-box-py/overview.md +275 -0
- package/.agents/skills/upstash/upstash-cli/overview.md +138 -0
- package/.agents/skills/upstash/upstash-qstash-js/advanced/callbacks.md +147 -0
- package/.agents/skills/upstash/upstash-qstash-js/advanced/deduplication.md +86 -0
- package/.agents/skills/upstash/upstash-qstash-js/advanced/dlq.md +164 -0
- package/.agents/skills/upstash/upstash-qstash-js/advanced/multi-region/summary.md +388 -0
- package/.agents/skills/upstash/upstash-qstash-js/advanced/multi-region/verify-multi-region-setup.ts +388 -0
- package/.agents/skills/upstash/upstash-qstash-js/fundamentals/local-development.md +106 -0
- package/.agents/skills/upstash/upstash-qstash-js/fundamentals/publishing-messages.md +144 -0
- package/.agents/skills/upstash/upstash-qstash-js/fundamentals/queues-and-flow-control.md +148 -0
- package/.agents/skills/upstash/upstash-qstash-js/fundamentals/schedules.md +177 -0
- package/.agents/skills/upstash/upstash-qstash-js/fundamentals/url-groups.md +127 -0
- package/.agents/skills/upstash/upstash-qstash-js/overview.md +81 -0
- package/.agents/skills/upstash/upstash-qstash-js/verification/platform-specific/nextjs.md +171 -0
- package/.agents/skills/upstash/upstash-qstash-js/verification/receiver.md +213 -0
- package/.agents/skills/upstash/upstash-ratelimit-js/algorithms.md +84 -0
- package/.agents/skills/upstash/upstash-ratelimit-js/features.md +117 -0
- package/.agents/skills/upstash/upstash-ratelimit-js/methods-getting-started.md +77 -0
- package/.agents/skills/upstash/upstash-ratelimit-js/overview.md +26 -0
- package/.agents/skills/upstash/upstash-ratelimit-js/pricing-cost.md +146 -0
- package/.agents/skills/upstash/upstash-ratelimit-js/traffic-protection.md +77 -0
- package/.agents/skills/upstash/upstash-redis-js/advanced-features/auto-pipeline.md +49 -0
- package/.agents/skills/upstash/upstash-redis-js/advanced-features/pipeline-and-transactions.md +42 -0
- package/.agents/skills/upstash/upstash-redis-js/advanced-features/scripting.md +124 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/hashes.md +71 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/json.md +133 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/lists.md +72 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/sets.md +90 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/sorted-sets.md +126 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/streams.md +196 -0
- package/.agents/skills/upstash/upstash-redis-js/data-structures/strings.md +73 -0
- package/.agents/skills/upstash/upstash-redis-js/migrations/from-ioredis.md +163 -0
- package/.agents/skills/upstash/upstash-redis-js/migrations/from-redis-node.md +205 -0
- package/.agents/skills/upstash/upstash-redis-js/overview.md +183 -0
- package/.agents/skills/upstash/upstash-redis-js/patterns/caching.md +58 -0
- package/.agents/skills/upstash/upstash-redis-js/patterns/distributed-locks.md +130 -0
- package/.agents/skills/upstash/upstash-redis-js/patterns/leaderboard.md +134 -0
- package/.agents/skills/upstash/upstash-redis-js/patterns/rate-limiting.md +187 -0
- package/.agents/skills/upstash/upstash-redis-js/patterns/session-management.md +217 -0
- package/.agents/skills/upstash/upstash-redis-js/performance/batching-operations.md +76 -0
- package/.agents/skills/upstash/upstash-redis-js/performance/data-serialization.md +134 -0
- package/.agents/skills/upstash/upstash-redis-js/performance/error-handling.md +118 -0
- package/.agents/skills/upstash/upstash-redis-js/performance/pipeline-optimization.md +105 -0
- package/.agents/skills/upstash/upstash-redis-js/performance/redis-replicas.md +14 -0
- package/.agents/skills/upstash/upstash-redis-js/performance/ttl-expiration.md +32 -0
- package/.agents/skills/upstash/upstash-redis-js/search/adapters.md +99 -0
- package/.agents/skills/upstash/upstash-redis-js/search/commands/aggregating.md +234 -0
- package/.agents/skills/upstash/upstash-redis-js/search/commands/aliases.md +76 -0
- package/.agents/skills/upstash/upstash-redis-js/search/commands/index-management.md +124 -0
- package/.agents/skills/upstash/upstash-redis-js/search/commands/querying.md +315 -0
- package/.agents/skills/upstash/upstash-redis-js/search/overview.md +155 -0
- package/.agents/skills/upstash/upstash-redis-start/overview.md +71 -0
- package/.agents/skills/upstash/upstash-search-js/overview.md +48 -0
- package/.agents/skills/upstash/upstash-search-js/quick-start.md +158 -0
- package/.agents/skills/upstash/upstash-search-js/sdk-overview.md +158 -0
- package/.agents/skills/upstash/upstash-vector-js/features/filtering-and-metadata.md +82 -0
- package/.agents/skills/upstash/upstash-vector-js/features/index-structure.md +193 -0
- package/.agents/skills/upstash/upstash-vector-js/features/namespaces.md +32 -0
- package/.agents/skills/upstash/upstash-vector-js/overview.md +44 -0
- package/.agents/skills/upstash/upstash-vector-js/sdk-methods.md +210 -0
- package/.agents/skills/upstash/upstash-workflow-js/agents.md +248 -0
- package/.agents/skills/upstash/upstash-workflow-js/basics/client.md +180 -0
- package/.agents/skills/upstash/upstash-workflow-js/basics/context.md +230 -0
- package/.agents/skills/upstash/upstash-workflow-js/basics/serve.md +70 -0
- package/.agents/skills/upstash/upstash-workflow-js/features/flow-control.md +145 -0
- package/.agents/skills/upstash/upstash-workflow-js/features/invoke.md +97 -0
- package/.agents/skills/upstash/upstash-workflow-js/features/retries-failures-reliability.md +239 -0
- package/.agents/skills/upstash/upstash-workflow-js/features/wait-for-event.md +97 -0
- package/.agents/skills/upstash/upstash-workflow-js/features/webhooks.md +79 -0
- package/.agents/skills/upstash/upstash-workflow-js/how-to/local-dev.md +177 -0
- package/.agents/skills/upstash/upstash-workflow-js/how-to/middleware.md +166 -0
- package/.agents/skills/upstash/upstash-workflow-js/how-to/migrations.md +201 -0
- package/.agents/skills/upstash/upstash-workflow-js/how-to/realtime.md +186 -0
- package/.agents/skills/upstash/upstash-workflow-js/overview.md +55 -0
- package/.agents/skills/upstash/upstash-workflow-js/rest-api.md +156 -0
- package/.agents/skills/upstash/upstash-workflow-js/troubleshooting.md +201 -0
- package/.agents/skills/upstash-box-js/SKILL.md +248 -0
- package/.agents/skills/upstash-box-py/SKILL.md +280 -0
- package/.agents/skills/upstash-cli/SKILL.md +143 -0
- package/.agents/skills/upstash-qstash-js/SKILL.md +86 -0
- package/.agents/skills/upstash-qstash-js/advanced/callbacks.md +147 -0
- package/.agents/skills/upstash-qstash-js/advanced/deduplication.md +86 -0
- package/.agents/skills/upstash-qstash-js/advanced/dlq.md +164 -0
- package/.agents/skills/upstash-qstash-js/advanced/multi-region/summary.md +388 -0
- package/.agents/skills/upstash-qstash-js/advanced/multi-region/verify-multi-region-setup.ts +388 -0
- package/.agents/skills/upstash-qstash-js/fundamentals/local-development.md +106 -0
- package/.agents/skills/upstash-qstash-js/fundamentals/publishing-messages.md +144 -0
- package/.agents/skills/upstash-qstash-js/fundamentals/queues-and-flow-control.md +148 -0
- package/.agents/skills/upstash-qstash-js/fundamentals/schedules.md +177 -0
- package/.agents/skills/upstash-qstash-js/fundamentals/url-groups.md +127 -0
- package/.agents/skills/upstash-qstash-js/verification/platform-specific/nextjs.md +171 -0
- package/.agents/skills/upstash-qstash-js/verification/receiver.md +213 -0
- package/.agents/skills/upstash-ratelimit-js/SKILL.md +31 -0
- package/.agents/skills/upstash-ratelimit-js/algorithms.md +84 -0
- package/.agents/skills/upstash-ratelimit-js/features.md +117 -0
- package/.agents/skills/upstash-ratelimit-js/methods-getting-started.md +77 -0
- package/.agents/skills/upstash-ratelimit-js/pricing-cost.md +146 -0
- package/.agents/skills/upstash-ratelimit-js/traffic-protection.md +77 -0
- package/.agents/skills/upstash-redis-js/SKILL.md +188 -0
- package/.agents/skills/upstash-redis-js/advanced-features/auto-pipeline.md +49 -0
- package/.agents/skills/upstash-redis-js/advanced-features/pipeline-and-transactions.md +42 -0
- package/.agents/skills/upstash-redis-js/advanced-features/scripting.md +124 -0
- package/.agents/skills/upstash-redis-js/data-structures/hashes.md +71 -0
- package/.agents/skills/upstash-redis-js/data-structures/json.md +133 -0
- package/.agents/skills/upstash-redis-js/data-structures/lists.md +72 -0
- package/.agents/skills/upstash-redis-js/data-structures/sets.md +90 -0
- package/.agents/skills/upstash-redis-js/data-structures/sorted-sets.md +126 -0
- package/.agents/skills/upstash-redis-js/data-structures/streams.md +196 -0
- package/.agents/skills/upstash-redis-js/data-structures/strings.md +73 -0
- package/.agents/skills/upstash-redis-js/migrations/from-ioredis.md +163 -0
- package/.agents/skills/upstash-redis-js/migrations/from-redis-node.md +205 -0
- package/.agents/skills/upstash-redis-js/patterns/caching.md +58 -0
- package/.agents/skills/upstash-redis-js/patterns/distributed-locks.md +130 -0
- package/.agents/skills/upstash-redis-js/patterns/leaderboard.md +134 -0
- package/.agents/skills/upstash-redis-js/patterns/rate-limiting.md +187 -0
- package/.agents/skills/upstash-redis-js/patterns/session-management.md +217 -0
- package/.agents/skills/upstash-redis-js/performance/batching-operations.md +76 -0
- package/.agents/skills/upstash-redis-js/performance/data-serialization.md +134 -0
- package/.agents/skills/upstash-redis-js/performance/error-handling.md +118 -0
- package/.agents/skills/upstash-redis-js/performance/pipeline-optimization.md +105 -0
- package/.agents/skills/upstash-redis-js/performance/redis-replicas.md +14 -0
- package/.agents/skills/upstash-redis-js/performance/ttl-expiration.md +32 -0
- package/.agents/skills/upstash-redis-js/search/adapters.md +99 -0
- package/.agents/skills/upstash-redis-js/search/commands/aggregating.md +234 -0
- package/.agents/skills/upstash-redis-js/search/commands/aliases.md +76 -0
- package/.agents/skills/upstash-redis-js/search/commands/index-management.md +124 -0
- package/.agents/skills/upstash-redis-js/search/commands/querying.md +315 -0
- package/.agents/skills/upstash-redis-js/search/overview.md +155 -0
- package/.agents/skills/upstash-redis-start/SKILL.md +76 -0
- package/.agents/skills/upstash-search-js/SKILL.md +53 -0
- package/.agents/skills/upstash-search-js/quick-start.md +158 -0
- package/.agents/skills/upstash-search-js/sdk-overview.md +158 -0
- package/.agents/skills/upstash-vector-js/SKILL.md +49 -0
- package/.agents/skills/upstash-vector-js/features/filtering-and-metadata.md +82 -0
- package/.agents/skills/upstash-vector-js/features/index-structure.md +193 -0
- package/.agents/skills/upstash-vector-js/features/namespaces.md +32 -0
- package/.agents/skills/upstash-vector-js/sdk-methods.md +210 -0
- package/.agents/skills/upstash-workflow-js/SKILL.md +60 -0
- package/.agents/skills/upstash-workflow-js/agents.md +248 -0
- package/.agents/skills/upstash-workflow-js/basics/client.md +180 -0
- package/.agents/skills/upstash-workflow-js/basics/context.md +230 -0
- package/.agents/skills/upstash-workflow-js/basics/serve.md +70 -0
- package/.agents/skills/upstash-workflow-js/features/flow-control.md +145 -0
- package/.agents/skills/upstash-workflow-js/features/invoke.md +97 -0
- package/.agents/skills/upstash-workflow-js/features/retries-failures-reliability.md +239 -0
- package/.agents/skills/upstash-workflow-js/features/wait-for-event.md +97 -0
- package/.agents/skills/upstash-workflow-js/features/webhooks.md +79 -0
- package/.agents/skills/upstash-workflow-js/how-to/local-dev.md +177 -0
- package/.agents/skills/upstash-workflow-js/how-to/middleware.md +166 -0
- package/.agents/skills/upstash-workflow-js/how-to/migrations.md +201 -0
- package/.agents/skills/upstash-workflow-js/how-to/realtime.md +186 -0
- package/.agents/skills/upstash-workflow-js/rest-api.md +156 -0
- package/.agents/skills/upstash-workflow-js/troubleshooting.md +201 -0
- package/dist/agents/coding.agent.d.ts +185 -42
- package/dist/agents/coding.agent.d.ts.map +1 -1
- package/dist/agents/coding.agent.js +42 -5
- package/dist/agents/coding.agent.js.map +1 -1
- package/dist/agents/manager.d.ts +216 -41
- package/dist/agents/manager.d.ts.map +1 -1
- package/dist/agents/manager.js +103 -140
- package/dist/agents/manager.js.map +1 -1
- package/dist/agents/security.agent.d.ts +3 -3
- package/dist/agents/swarm/development/lead.d.ts +3 -0
- package/dist/agents/swarm/development/lead.d.ts.map +1 -0
- package/dist/agents/swarm/development/lead.js +24 -0
- package/dist/agents/swarm/development/lead.js.map +1 -0
- package/dist/agents/swarm/main.d.ts +69 -0
- package/dist/agents/swarm/main.d.ts.map +1 -1
- package/dist/agents/swarm/main.js +65 -11
- package/dist/agents/swarm/main.js.map +1 -1
- package/dist/agents/swarm/registry.d.ts +2 -1
- package/dist/agents/swarm/registry.d.ts.map +1 -1
- package/dist/agents/swarm/registry.js +225 -95
- package/dist/agents/swarm/registry.js.map +1 -1
- package/dist/cli/composer.d.ts.map +1 -1
- package/dist/cli/composer.js +85 -30
- package/dist/cli/composer.js.map +1 -1
- package/dist/cli/confirm.d.ts +2 -2
- package/dist/cli/confirm.d.ts.map +1 -1
- package/dist/cli/confirm.js +373 -4
- package/dist/cli/confirm.js.map +1 -1
- package/dist/cli/doctor.d.ts +1 -0
- package/dist/cli/doctor.d.ts.map +1 -1
- package/dist/cli/doctor.js +47 -2
- package/dist/cli/doctor.js.map +1 -1
- package/dist/cli/format.d.ts +4 -0
- package/dist/cli/format.d.ts.map +1 -1
- package/dist/cli/format.js +352 -65
- package/dist/cli/format.js.map +1 -1
- package/dist/cli/interactive.d.ts.map +1 -1
- package/dist/cli/interactive.js +80 -2
- package/dist/cli/interactive.js.map +1 -1
- package/dist/cli/menu.d.ts.map +1 -1
- package/dist/cli/menu.js +93 -83
- package/dist/cli/menu.js.map +1 -1
- package/dist/cli/render.d.ts.map +1 -1
- package/dist/cli/render.js +2 -1
- package/dist/cli/render.js.map +1 -1
- package/dist/cli/setup.d.ts.map +1 -1
- package/dist/cli/setup.js +292 -28
- package/dist/cli/setup.js.map +1 -1
- package/dist/cli/swarm.d.ts.map +1 -1
- package/dist/cli/swarm.js +13 -10
- package/dist/cli/swarm.js.map +1 -1
- package/dist/cli/theme.d.ts +7 -1
- package/dist/cli/theme.d.ts.map +1 -1
- package/dist/cli/theme.js +4 -16
- package/dist/cli/theme.js.map +1 -1
- package/dist/cli/tunnel.d.ts +2 -0
- package/dist/cli/tunnel.d.ts.map +1 -1
- package/dist/cli/tunnel.js +63 -7
- package/dist/cli/tunnel.js.map +1 -1
- package/dist/cli/update.d.ts.map +1 -1
- package/dist/cli/update.js +12 -4
- package/dist/cli/update.js.map +1 -1
- package/dist/config/env.d.ts +3 -1
- package/dist/config/env.d.ts.map +1 -1
- package/dist/config/env.js +22 -2
- package/dist/config/env.js.map +1 -1
- package/dist/config/models.d.ts +1 -0
- package/dist/config/models.d.ts.map +1 -1
- package/dist/config/models.js +17 -1
- package/dist/config/models.js.map +1 -1
- package/dist/documents/pdf.d.ts.map +1 -1
- package/dist/documents/pdf.js +282 -22
- package/dist/documents/pdf.js.map +1 -1
- package/dist/documents/slides.d.ts.map +1 -1
- package/dist/documents/slides.js +160 -30
- package/dist/documents/slides.js.map +1 -1
- package/dist/index.js +73 -18
- package/dist/index.js.map +1 -1
- package/dist/memory/history.js +1 -1
- package/dist/observability/doctor.d.ts.map +1 -1
- package/dist/observability/doctor.js +3 -0
- package/dist/observability/doctor.js.map +1 -1
- package/dist/runtime/progress.d.ts +5 -1
- package/dist/runtime/progress.d.ts.map +1 -1
- package/dist/runtime/progress.js.map +1 -1
- package/dist/runtime/swarm.d.ts +1 -1
- package/dist/runtime/swarm.d.ts.map +1 -1
- package/dist/runtime/swarm.js +19 -3
- package/dist/runtime/swarm.js.map +1 -1
- package/dist/runtime/tool-utils.d.ts +2 -0
- package/dist/runtime/tool-utils.d.ts.map +1 -1
- package/dist/runtime/tool-utils.js +91 -0
- package/dist/runtime/tool-utils.js.map +1 -1
- package/dist/server.js +1 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/loader.d.ts.map +1 -1
- package/dist/skills/loader.js +16 -0
- package/dist/skills/loader.js.map +1 -1
- package/dist/test-call.d.ts +2 -0
- package/dist/test-call.d.ts.map +1 -0
- package/dist/test-call.js +29 -0
- package/dist/test-call.js.map +1 -0
- package/dist/test-manager-call.d.ts +2 -0
- package/dist/test-manager-call.d.ts.map +1 -0
- package/dist/test-manager-call.js +138 -0
- package/dist/test-manager-call.js.map +1 -0
- package/dist/test-manager-filtered.d.ts +2 -0
- package/dist/test-manager-filtered.d.ts.map +1 -0
- package/dist/test-manager-filtered.js +130 -0
- package/dist/test-manager-filtered.js.map +1 -0
- package/dist/test-mcp-call.d.ts +2 -0
- package/dist/test-mcp-call.d.ts.map +1 -0
- package/dist/test-mcp-call.js +103 -0
- package/dist/test-mcp-call.js.map +1 -0
- package/dist/tools/composio.tool.d.ts +1 -1
- package/dist/tools/composio.tool.d.ts.map +1 -1
- package/dist/tools/composio.tool.js +7 -16
- package/dist/tools/composio.tool.js.map +1 -1
- package/dist/tools/executive.tool.d.ts +40 -0
- package/dist/tools/executive.tool.d.ts.map +1 -0
- package/dist/tools/executive.tool.js +74 -0
- package/dist/tools/executive.tool.js.map +1 -0
- package/dist/tools/filesystem.tool.d.ts +183 -40
- package/dist/tools/filesystem.tool.d.ts.map +1 -1
- package/dist/tools/filesystem.tool.js +564 -111
- package/dist/tools/filesystem.tool.js.map +1 -1
- package/dist/tools/mcp.tool.d.ts +56 -0
- package/dist/tools/mcp.tool.d.ts.map +1 -0
- package/dist/tools/mcp.tool.js +285 -0
- package/dist/tools/mcp.tool.js.map +1 -0
- package/dist/tools/osint.tool.d.ts +4 -4
- package/dist/tools/pentest.tool.d.ts +2 -2
- package/dist/tools/setup-assistant.tool.d.ts +1 -1
- package/dist/tools/setup-assistant.tool.js +1 -1
- package/dist/tools/setup-assistant.tool.js.map +1 -1
- package/dist/workspace/paths.d.ts +1 -0
- package/dist/workspace/paths.d.ts.map +1 -1
- package/dist/workspace/paths.js +3 -4
- package/dist/workspace/paths.js.map +1 -1
- package/package.json +6 -3
- package/scripts/postinstall.mjs +19 -4
- package/scripts/release-github.mjs +13 -11
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
# Natural Transitions
|
|
2
|
+
|
|
3
|
+
Transitional phrases to guide readers through your content. Good signposting improves readability, user engagement, and helps search engines understand content structure.
|
|
4
|
+
|
|
5
|
+
Adapted from: University of Manchester Academic Phrasebank (2023), Plain English Campaign, web content best practices
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Contents
|
|
10
|
+
- Previewing Content Structure
|
|
11
|
+
- Introducing a New Topic
|
|
12
|
+
- Referring Back
|
|
13
|
+
- Moving Between Sections
|
|
14
|
+
- Indicating Addition
|
|
15
|
+
- Indicating Contrast
|
|
16
|
+
- Indicating Similarity
|
|
17
|
+
- Indicating Cause and Effect
|
|
18
|
+
- Giving Examples
|
|
19
|
+
- Emphasising Key Points
|
|
20
|
+
- Providing Evidence (neutral attribution, expert quotes, supporting claims)
|
|
21
|
+
- Summarising Sections
|
|
22
|
+
- Concluding Content
|
|
23
|
+
- Question-Based Transitions
|
|
24
|
+
- List Introductions
|
|
25
|
+
- Hedging Language
|
|
26
|
+
- Best Practice Guidelines
|
|
27
|
+
- Transitions to Avoid (AI Tells)
|
|
28
|
+
|
|
29
|
+
## Previewing Content Structure
|
|
30
|
+
|
|
31
|
+
Use to orient readers and set expectations:
|
|
32
|
+
|
|
33
|
+
- Here's what we'll cover...
|
|
34
|
+
- This guide walks you through...
|
|
35
|
+
- Below, you'll find...
|
|
36
|
+
- We'll start with X, then move to Y...
|
|
37
|
+
- First, let's look at...
|
|
38
|
+
- Let's break this down step by step.
|
|
39
|
+
- The sections below explain...
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Introducing a New Topic
|
|
44
|
+
|
|
45
|
+
- When it comes to X,...
|
|
46
|
+
- Regarding X,...
|
|
47
|
+
- Speaking of X,...
|
|
48
|
+
- Now let's talk about X.
|
|
49
|
+
- Another key factor is...
|
|
50
|
+
- X is worth exploring because...
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Referring Back
|
|
55
|
+
|
|
56
|
+
Use to connect ideas and reinforce key points:
|
|
57
|
+
|
|
58
|
+
- As mentioned earlier,...
|
|
59
|
+
- As we covered above,...
|
|
60
|
+
- Remember when we discussed X?
|
|
61
|
+
- Building on that point,...
|
|
62
|
+
- Going back to X,...
|
|
63
|
+
- Earlier, we explained that...
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Moving Between Sections
|
|
68
|
+
|
|
69
|
+
- Now let's look at...
|
|
70
|
+
- Next up:...
|
|
71
|
+
- Moving on to...
|
|
72
|
+
- With that covered, let's turn to...
|
|
73
|
+
- Now that you understand X, here's Y.
|
|
74
|
+
- That brings us to...
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Indicating Addition
|
|
79
|
+
|
|
80
|
+
- Also,...
|
|
81
|
+
- Plus,...
|
|
82
|
+
- On top of that,...
|
|
83
|
+
- What's more,...
|
|
84
|
+
- Another benefit is...
|
|
85
|
+
- Beyond that,...
|
|
86
|
+
- In addition,...
|
|
87
|
+
- There's also...
|
|
88
|
+
|
|
89
|
+
**Note:** Use "moreover" and "furthermore" sparingly. They can sound AI-generated when overused.
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Indicating Contrast
|
|
94
|
+
|
|
95
|
+
- However,...
|
|
96
|
+
- But,...
|
|
97
|
+
- That said,...
|
|
98
|
+
- On the flip side,...
|
|
99
|
+
- In contrast,...
|
|
100
|
+
- Unlike X, Y...
|
|
101
|
+
- While X is true, Y...
|
|
102
|
+
- Despite this,...
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Indicating Similarity
|
|
107
|
+
|
|
108
|
+
- Similarly,...
|
|
109
|
+
- Likewise,...
|
|
110
|
+
- In the same way,...
|
|
111
|
+
- Just like X, Y also...
|
|
112
|
+
- This mirrors...
|
|
113
|
+
- The same applies to...
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Indicating Cause and Effect
|
|
118
|
+
|
|
119
|
+
- So,...
|
|
120
|
+
- This means...
|
|
121
|
+
- As a result,...
|
|
122
|
+
- That's why...
|
|
123
|
+
- Because of this,...
|
|
124
|
+
- This leads to...
|
|
125
|
+
- The outcome?...
|
|
126
|
+
- Here's what happens:...
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Giving Examples
|
|
131
|
+
|
|
132
|
+
- For example,...
|
|
133
|
+
- For instance,...
|
|
134
|
+
- Here's an example:...
|
|
135
|
+
- Take X, for instance.
|
|
136
|
+
- Consider this:...
|
|
137
|
+
- A good example is...
|
|
138
|
+
- To illustrate,...
|
|
139
|
+
- Like when...
|
|
140
|
+
- Say you want to...
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Emphasising Key Points
|
|
145
|
+
|
|
146
|
+
- Here's the key takeaway:...
|
|
147
|
+
- The important thing is...
|
|
148
|
+
- What matters most is...
|
|
149
|
+
- Don't miss this:...
|
|
150
|
+
- Pay attention to...
|
|
151
|
+
- This is critical:...
|
|
152
|
+
- The bottom line?...
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Providing Evidence
|
|
157
|
+
|
|
158
|
+
Use when citing sources, data, or expert opinions:
|
|
159
|
+
|
|
160
|
+
### Neutral attribution
|
|
161
|
+
- According to [Source],...
|
|
162
|
+
- [Source] reports that...
|
|
163
|
+
- Research shows that...
|
|
164
|
+
- Data from [Source] indicates...
|
|
165
|
+
- A study by [Source] found...
|
|
166
|
+
|
|
167
|
+
### Expert quotes
|
|
168
|
+
- As [Expert] puts it,...
|
|
169
|
+
- [Expert] explains,...
|
|
170
|
+
- In the words of [Expert],...
|
|
171
|
+
- [Expert] notes that...
|
|
172
|
+
|
|
173
|
+
### Supporting claims
|
|
174
|
+
- This is backed by...
|
|
175
|
+
- Evidence suggests...
|
|
176
|
+
- The numbers confirm...
|
|
177
|
+
- This aligns with findings from...
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Summarising Sections
|
|
182
|
+
|
|
183
|
+
- To recap,...
|
|
184
|
+
- Here's the short version:...
|
|
185
|
+
- In short,...
|
|
186
|
+
- The takeaway?...
|
|
187
|
+
- So what does this mean?...
|
|
188
|
+
- Let's pull this together:...
|
|
189
|
+
- Quick summary:...
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## Concluding Content
|
|
194
|
+
|
|
195
|
+
- Wrapping up,...
|
|
196
|
+
- The bottom line is...
|
|
197
|
+
- Here's what to do next:...
|
|
198
|
+
- To sum up,...
|
|
199
|
+
- Final thoughts:...
|
|
200
|
+
- Ready to get started?...
|
|
201
|
+
- Now it's your turn.
|
|
202
|
+
|
|
203
|
+
**Note:** Avoid "In conclusion" at the start of a paragraph. It's overused and signals AI writing.
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Question-Based Transitions
|
|
208
|
+
|
|
209
|
+
Useful for conversational tone and featured snippet optimization:
|
|
210
|
+
|
|
211
|
+
- So what does this mean for you?
|
|
212
|
+
- But why does this matter?
|
|
213
|
+
- How do you actually do this?
|
|
214
|
+
- What's the catch?
|
|
215
|
+
- Sound complicated? It's not.
|
|
216
|
+
- Wondering where to start?
|
|
217
|
+
- Still not sure? Here's the breakdown.
|
|
218
|
+
|
|
219
|
+
---
|
|
220
|
+
|
|
221
|
+
## List Introductions
|
|
222
|
+
|
|
223
|
+
For numbered lists and step-by-step content:
|
|
224
|
+
|
|
225
|
+
- Here's how to do it:
|
|
226
|
+
- Follow these steps:
|
|
227
|
+
- The process is straightforward:
|
|
228
|
+
- Here's what you need to know:
|
|
229
|
+
- Key things to consider:
|
|
230
|
+
- The main factors are:
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Hedging Language
|
|
235
|
+
|
|
236
|
+
For claims that need qualification or aren't absolute:
|
|
237
|
+
|
|
238
|
+
- may, might, could
|
|
239
|
+
- tends to, generally
|
|
240
|
+
- often, usually, typically
|
|
241
|
+
- in most cases
|
|
242
|
+
- it appears that
|
|
243
|
+
- evidence suggests
|
|
244
|
+
- this can help
|
|
245
|
+
- many experts believe
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
## Best Practice Guidelines
|
|
250
|
+
|
|
251
|
+
1. **Match tone to audience**: B2B content can be slightly more formal; B2C often benefits from conversational transitions
|
|
252
|
+
2. **Vary your transitions**: Repeating the same phrase gets noticed (and not in a good way)
|
|
253
|
+
3. **Don't over-signpost**: Trust your reader; every sentence doesn't need a transition
|
|
254
|
+
4. **Use for scannability**: Transitions at paragraph starts help skimmers navigate
|
|
255
|
+
5. **Keep it natural**: Read aloud; if it sounds forced, simplify
|
|
256
|
+
6. **Front-load key info**: Put the important word or phrase early in the transition
|
|
257
|
+
|
|
258
|
+
---
|
|
259
|
+
|
|
260
|
+
## Transitions to Avoid (AI Tells)
|
|
261
|
+
|
|
262
|
+
These phrases are overused in AI-generated content:
|
|
263
|
+
|
|
264
|
+
- "That being said,..."
|
|
265
|
+
- "It's worth noting that..."
|
|
266
|
+
- "At its core,..."
|
|
267
|
+
- "In today's digital landscape,..."
|
|
268
|
+
- "When it comes to the realm of..."
|
|
269
|
+
- "This begs the question..."
|
|
270
|
+
- "Let's delve into..."
|
|
271
|
+
|
|
272
|
+
See the seo-audit skill's `references/ai-writing-detection.md` for a complete list of AI writing tells.
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: firecrawl-deep-research
|
|
3
|
+
description: |
|
|
4
|
+
Produce an intensive, cited analytical report: executive summary, multi-angle
|
|
5
|
+
findings, contrarian views, open questions, and full sources. Use only when the
|
|
6
|
+
user needs rigorous synthesis of a complex topic (scientific, technical, policy,
|
|
7
|
+
or market-analytical) that cannot be answered with a short search, and wants
|
|
8
|
+
a formal written report, not a recommendation list.
|
|
9
|
+
|
|
10
|
+
Do not use for product picks, top-N lists, quick lookups, or routine "find out
|
|
11
|
+
about X" tasks. If the request does not clearly need this kind of report, do
|
|
12
|
+
not use this skill.
|
|
13
|
+
license: ISC
|
|
14
|
+
metadata:
|
|
15
|
+
author: firecrawl
|
|
16
|
+
version: "0.1.0"
|
|
17
|
+
homepage: https://www.firecrawl.dev
|
|
18
|
+
source: https://github.com/firecrawl/firecrawl-workflows
|
|
19
|
+
inputs:
|
|
20
|
+
- name: FIRECRAWL_API_KEY
|
|
21
|
+
description: Firecrawl API key for hosted Firecrawl requests.
|
|
22
|
+
required: true
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
# Firecrawl Deep Research
|
|
26
|
+
|
|
27
|
+
Use this only for report-scale research: a rigorous, cited synthesis the user
|
|
28
|
+
explicitly wants delivered as a formal written report. If the request is a
|
|
29
|
+
product pick, a top-N list, a quick lookup, or anything answerable with a short
|
|
30
|
+
search, stop; do not use this skill, let the request be handled the standard
|
|
31
|
+
way.
|
|
32
|
+
|
|
33
|
+
## Onboarding Interview
|
|
34
|
+
|
|
35
|
+
Infer the topic and output format from context. Before starting, unless already specified, always ask one short question to define the scope:
|
|
36
|
+
|
|
37
|
+
> "How long do you want this research task to run?"
|
|
38
|
+
|
|
39
|
+
Map the answer to a depth tier in the Collection Plan below:
|
|
40
|
+
- A few minutes → Quick
|
|
41
|
+
- ~10-15 minutes → Thorough
|
|
42
|
+
- Longer / no limit → Exhaustive
|
|
43
|
+
|
|
44
|
+
If the topic itself is unclear, you may ask at most 1-2 additional concise
|
|
45
|
+
questions (topic, or a critical angle/source constraint). Otherwise proceed once
|
|
46
|
+
the runtime is set.
|
|
47
|
+
|
|
48
|
+
## Firecrawl Collection Plan
|
|
49
|
+
|
|
50
|
+
Use Firecrawl search and scrape through the CLI or equivalent tool surface. Match
|
|
51
|
+
depth to the runtime the user chose during onboarding.
|
|
52
|
+
|
|
53
|
+
- Quick (~a few minutes): search 3-5 queries and scrape 5-10 high-quality sources.
|
|
54
|
+
- Thorough (~10-15 minutes): search 5-10 queries from different angles and scrape 15-25 sources.
|
|
55
|
+
- Exhaustive (longer): search 10+ queries and scrape 25+ sources, including primary sources, research papers, expert views, and contrarian sources.
|
|
56
|
+
|
|
57
|
+
Avoid re-scraping URLs already returned with full content from a search-with-scrape result.
|
|
58
|
+
|
|
59
|
+
## Parallel Work
|
|
60
|
+
|
|
61
|
+
If appropriate, use sub-agents or equivalent parallel task runners by research angle:
|
|
62
|
+
|
|
63
|
+
- overview and definitions
|
|
64
|
+
- technical or implementation details
|
|
65
|
+
- market and industry context
|
|
66
|
+
- contrarian views, risks, and limitations
|
|
67
|
+
- primary sources and official docs
|
|
68
|
+
|
|
69
|
+
Each researcher should return claims, source URLs, source quality notes, and uncertainty.
|
|
70
|
+
|
|
71
|
+
## Final Deliverable
|
|
72
|
+
|
|
73
|
+
Default structure:
|
|
74
|
+
|
|
75
|
+
```markdown
|
|
76
|
+
# Deep Research: [Topic]
|
|
77
|
+
|
|
78
|
+
## Executive Summary
|
|
79
|
+
[2-3 paragraphs]
|
|
80
|
+
|
|
81
|
+
## Key Findings
|
|
82
|
+
[Numbered findings with source links]
|
|
83
|
+
|
|
84
|
+
## Detailed Analysis
|
|
85
|
+
[Themes, evidence, and synthesis]
|
|
86
|
+
|
|
87
|
+
## Contrarian Views And Risks
|
|
88
|
+
[Counterarguments, limitations, failure modes]
|
|
89
|
+
|
|
90
|
+
## Open Questions
|
|
91
|
+
[What remains uncertain]
|
|
92
|
+
|
|
93
|
+
## Sources
|
|
94
|
+
[Every URL used with a one-line note]
|
|
95
|
+
|
|
96
|
+
## Rerun Inputs
|
|
97
|
+
workflow: firecrawl-deep-research
|
|
98
|
+
topic: [topic]
|
|
99
|
+
depth: [quick/thorough/exhaustive]
|
|
100
|
+
output: [markdown/json/brief]
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Quality Bar
|
|
104
|
+
|
|
105
|
+
- Cite sources for factual claims.
|
|
106
|
+
- Prefer primary sources when available.
|
|
107
|
+
- Flag uncertainty and conflicting evidence.
|
|
108
|
+
- Synthesize instead of listing scrape summaries.
|
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: shadcn
|
|
3
|
+
description: Manages shadcn components and projects — adding, searching, fixing, debugging, styling, and composing UI. Provides project context, component docs, and usage examples. Applies when working with shadcn/ui, component registries, presets, --preset codes, or any project with a components.json file. Also triggers for "shadcn init", "create an app with --preset", or "switch to --preset".
|
|
4
|
+
user-invocable: false
|
|
5
|
+
allowed-tools: Bash(npx shadcn@latest *), Bash(pnpm dlx shadcn@latest *), Bash(bunx --bun shadcn@latest *)
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# shadcn/ui
|
|
9
|
+
|
|
10
|
+
A framework for building ui, components and design systems. Components are added as source code to the user's project via the CLI.
|
|
11
|
+
|
|
12
|
+
> **IMPORTANT:** Run all CLI commands using the project's package runner: `npx shadcn@latest`, `pnpm dlx shadcn@latest`, or `bunx --bun shadcn@latest` — based on the project's `packageManager`. Examples below use `npx shadcn@latest` but substitute the correct runner for the project.
|
|
13
|
+
|
|
14
|
+
## Current Project Context
|
|
15
|
+
|
|
16
|
+
```json
|
|
17
|
+
!`npx shadcn@latest info --json`
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The JSON above contains the project config and installed components. Use `npx shadcn@latest docs <component>` to get documentation and example URLs for any component.
|
|
21
|
+
|
|
22
|
+
## Principles
|
|
23
|
+
|
|
24
|
+
1. **Use existing components first.** Use `npx shadcn@latest search` to check registries before writing custom UI. Check community registries too.
|
|
25
|
+
2. **Compose, don't reinvent.** Settings page = Tabs + Card + form controls. Dashboard = Sidebar + Card + Chart + Table.
|
|
26
|
+
3. **Use built-in variants before custom styles.** `variant="outline"`, `size="sm"`, etc.
|
|
27
|
+
4. **Use semantic colors.** `bg-primary`, `text-muted-foreground` — never raw values like `bg-blue-500`.
|
|
28
|
+
|
|
29
|
+
## Critical Rules
|
|
30
|
+
|
|
31
|
+
These rules are **always enforced**. Each links to a file with Incorrect/Correct code pairs.
|
|
32
|
+
|
|
33
|
+
### Styling & Tailwind → [styling.md](./rules/styling.md)
|
|
34
|
+
|
|
35
|
+
- **`className` for layout, not styling.** Never override component colors or typography.
|
|
36
|
+
- **No `space-x-*` or `space-y-*`.** Use `flex` with `gap-*`. For vertical stacks, `flex flex-col gap-*`.
|
|
37
|
+
- **Use `size-*` when width and height are equal.** `size-10` not `w-10 h-10`.
|
|
38
|
+
- **Use `truncate` shorthand.** Not `overflow-hidden text-ellipsis whitespace-nowrap`.
|
|
39
|
+
- **No manual `dark:` color overrides.** Use semantic tokens (`bg-background`, `text-muted-foreground`).
|
|
40
|
+
- **Use `cn()` for conditional classes.** Don't write manual template literal ternaries.
|
|
41
|
+
- **No manual `z-index` on overlay components.** Dialog, Sheet, Popover, etc. handle their own stacking.
|
|
42
|
+
|
|
43
|
+
### Forms & Inputs → [forms.md](./rules/forms.md)
|
|
44
|
+
|
|
45
|
+
- **Forms use `FieldGroup` + `Field`.** Never use raw `div` with `space-y-*` or `grid gap-*` for form layout.
|
|
46
|
+
- **`InputGroup` uses `InputGroupInput`/`InputGroupTextarea`.** Never raw `Input`/`Textarea` inside `InputGroup`.
|
|
47
|
+
- **Buttons inside inputs use `InputGroup` + `InputGroupAddon`.**
|
|
48
|
+
- **Option sets (2–7 choices) use `ToggleGroup`.** Don't loop `Button` with manual active state.
|
|
49
|
+
- **`FieldSet` + `FieldLegend` for grouping related checkboxes/radios.** Don't use a `div` with a heading.
|
|
50
|
+
- **Field validation uses `data-invalid` + `aria-invalid`.** `data-invalid` on `Field`, `aria-invalid` on the control. For disabled: `data-disabled` on `Field`, `disabled` on the control.
|
|
51
|
+
|
|
52
|
+
### Component Structure → [composition.md](./rules/composition.md)
|
|
53
|
+
|
|
54
|
+
- **Items always inside their Group.** `SelectItem` → `SelectGroup`. `DropdownMenuItem` → `DropdownMenuGroup`. `CommandItem` → `CommandGroup`.
|
|
55
|
+
- **Use `asChild` (radix) or `render` (base) for custom triggers.** Check `base` field from `npx shadcn@latest info`. → [base-vs-radix.md](./rules/base-vs-radix.md)
|
|
56
|
+
- **Dialog, Sheet, and Drawer always need a Title.** `DialogTitle`, `SheetTitle`, `DrawerTitle` required for accessibility. Use `className="sr-only"` if visually hidden.
|
|
57
|
+
- **Use full Card composition.** `CardHeader`/`CardTitle`/`CardDescription`/`CardContent`/`CardFooter`. Don't dump everything in `CardContent`.
|
|
58
|
+
- **Button has no `isPending`/`isLoading`.** Compose with `Spinner` + `data-icon` + `disabled`.
|
|
59
|
+
- **`TabsTrigger` must be inside `TabsList`.** Never render triggers directly in `Tabs`.
|
|
60
|
+
- **`Avatar` always needs `AvatarFallback`.** For when the image fails to load.
|
|
61
|
+
|
|
62
|
+
### Use Components, Not Custom Markup → [composition.md](./rules/composition.md)
|
|
63
|
+
|
|
64
|
+
- **Use existing components before custom markup.** Check if a component exists before writing a styled `div`.
|
|
65
|
+
- **Callouts use `Alert`.** Don't build custom styled divs.
|
|
66
|
+
- **Empty states use `Empty`.** Don't build custom empty state markup.
|
|
67
|
+
- **Toast via `sonner`.** Use `toast()` from `sonner`.
|
|
68
|
+
- **Use `Separator`** instead of `<hr>` or `<div className="border-t">`.
|
|
69
|
+
- **Use `Skeleton`** for loading placeholders. No custom `animate-pulse` divs.
|
|
70
|
+
- **Use `Badge`** instead of custom styled spans.
|
|
71
|
+
|
|
72
|
+
### Icons → [icons.md](./rules/icons.md)
|
|
73
|
+
|
|
74
|
+
- **Icons in `Button` use `data-icon`.** `data-icon="inline-start"` or `data-icon="inline-end"` on the icon.
|
|
75
|
+
- **No sizing classes on icons inside components.** Components handle icon sizing via CSS. No `size-4` or `w-4 h-4`.
|
|
76
|
+
- **Pass icons as objects, not string keys.** `icon={CheckIcon}`, not a string lookup.
|
|
77
|
+
|
|
78
|
+
### CLI
|
|
79
|
+
|
|
80
|
+
- **Never decode preset codes or build preset URLs manually.** Use `npx shadcn@latest preset decode <code>`, `preset url <code>`, or `preset open <code>`. For project-aware preset detection, use `npx shadcn@latest preset resolve`.
|
|
81
|
+
- **Apply preset codes directly with the CLI.** Use `npx shadcn@latest apply <code>` for existing projects, or `npx shadcn@latest init --preset <code>` when initializing.
|
|
82
|
+
|
|
83
|
+
## Key Patterns
|
|
84
|
+
|
|
85
|
+
These are the most common patterns that differentiate correct shadcn/ui code. For edge cases, see the linked rule files above.
|
|
86
|
+
|
|
87
|
+
```tsx
|
|
88
|
+
// Form layout: FieldGroup + Field, not div + Label.
|
|
89
|
+
<FieldGroup>
|
|
90
|
+
<Field>
|
|
91
|
+
<FieldLabel htmlFor="email">Email</FieldLabel>
|
|
92
|
+
<Input id="email" />
|
|
93
|
+
</Field>
|
|
94
|
+
</FieldGroup>
|
|
95
|
+
|
|
96
|
+
// Validation: data-invalid on Field, aria-invalid on the control.
|
|
97
|
+
<Field data-invalid>
|
|
98
|
+
<FieldLabel>Email</FieldLabel>
|
|
99
|
+
<Input aria-invalid />
|
|
100
|
+
<FieldDescription>Invalid email.</FieldDescription>
|
|
101
|
+
</Field>
|
|
102
|
+
|
|
103
|
+
// Icons in buttons: data-icon, no sizing classes.
|
|
104
|
+
<Button>
|
|
105
|
+
<SearchIcon data-icon="inline-start" />
|
|
106
|
+
Search
|
|
107
|
+
</Button>
|
|
108
|
+
|
|
109
|
+
// Spacing: gap-*, not space-y-*.
|
|
110
|
+
<div className="flex flex-col gap-4"> // correct
|
|
111
|
+
<div className="space-y-4"> // wrong
|
|
112
|
+
|
|
113
|
+
// Equal dimensions: size-*, not w-* h-*.
|
|
114
|
+
<Avatar className="size-10"> // correct
|
|
115
|
+
<Avatar className="w-10 h-10"> // wrong
|
|
116
|
+
|
|
117
|
+
// Status colors: Badge variants or semantic tokens, not raw colors.
|
|
118
|
+
<Badge variant="secondary">+20.1%</Badge> // correct
|
|
119
|
+
<span className="text-emerald-600">+20.1%</span> // wrong
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Component Selection
|
|
123
|
+
|
|
124
|
+
| Need | Use |
|
|
125
|
+
| -------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
126
|
+
| Button/action | `Button` with appropriate variant |
|
|
127
|
+
| Form inputs | `Input`, `Select`, `Combobox`, `Switch`, `Checkbox`, `RadioGroup`, `Textarea`, `InputOTP`, `Slider` |
|
|
128
|
+
| Toggle between 2–5 options | `ToggleGroup` + `ToggleGroupItem` |
|
|
129
|
+
| Data display | `Table`, `Card`, `Badge`, `Avatar` |
|
|
130
|
+
| Navigation | `Sidebar`, `NavigationMenu`, `Breadcrumb`, `Tabs`, `Pagination` |
|
|
131
|
+
| Overlays | `Dialog` (modal), `Sheet` (side panel), `Drawer` (bottom sheet), `AlertDialog` (confirmation) |
|
|
132
|
+
| Feedback | `sonner` (toast), `Alert`, `Progress`, `Skeleton`, `Spinner` |
|
|
133
|
+
| Command palette | `Command` inside `Dialog` |
|
|
134
|
+
| Charts | `Chart` (wraps Recharts) |
|
|
135
|
+
| Layout | `Card`, `Separator`, `Resizable`, `ScrollArea`, `Accordion`, `Collapsible` |
|
|
136
|
+
| Empty states | `Empty` |
|
|
137
|
+
| Menus | `DropdownMenu`, `ContextMenu`, `Menubar` |
|
|
138
|
+
| Tooltips/info | `Tooltip`, `HoverCard`, `Popover` |
|
|
139
|
+
|
|
140
|
+
## Key Fields
|
|
141
|
+
|
|
142
|
+
The injected project context contains these key fields:
|
|
143
|
+
|
|
144
|
+
- **`aliases`** → use the actual alias prefix for imports (e.g. `@/`, `~/`), never hardcode.
|
|
145
|
+
- **`isRSC`** → when `true`, components using `useState`, `useEffect`, event handlers, or browser APIs need `"use client"` at the top of the file. Always reference this field when advising on the directive.
|
|
146
|
+
- **`tailwindVersion`** → `"v4"` uses `@theme inline` blocks; `"v3"` uses `tailwind.config.js`.
|
|
147
|
+
- **`tailwindCssFile`** → the global CSS file where custom CSS variables are defined. Always edit this file, never create a new one.
|
|
148
|
+
- **`style`** → component visual treatment (e.g. `nova`, `vega`).
|
|
149
|
+
- **`base`** → primitive library (`radix` or `base`). Affects component APIs and available props.
|
|
150
|
+
- **`iconLibrary`** → determines icon imports. Use `lucide-react` for `lucide`, `@tabler/icons-react` for `tabler`, etc. Never assume `lucide-react`.
|
|
151
|
+
- **`resolvedPaths`** → exact file-system destinations for components, utils, hooks, etc.
|
|
152
|
+
- **`framework`** → routing and file conventions (e.g. Next.js App Router vs Vite SPA).
|
|
153
|
+
- **`packageManager`** → use this for any non-shadcn dependency installs (e.g. `pnpm add date-fns` vs `npm install date-fns`).
|
|
154
|
+
- **`preset`** → resolved preset code and values for the current project. Use `npx shadcn@latest preset resolve --json` when you only need preset information.
|
|
155
|
+
|
|
156
|
+
See [cli.md — `info` command](./cli.md) for the full field reference.
|
|
157
|
+
|
|
158
|
+
## Component Docs, Examples, and Usage
|
|
159
|
+
|
|
160
|
+
Run `npx shadcn@latest docs <component>` to get the URLs for a component's documentation, examples, and API reference. Fetch these URLs to get the actual content.
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
npx shadcn@latest docs button dialog select
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
**When creating, fixing, debugging, or using a component, always run `npx shadcn@latest docs` and fetch the URLs first.** This ensures you're working with the correct API and usage patterns rather than guessing.
|
|
167
|
+
|
|
168
|
+
## Workflow
|
|
169
|
+
|
|
170
|
+
1. **Get project context** — already injected above. Run `npx shadcn@latest info` again if you need to refresh.
|
|
171
|
+
2. **Check installed components first** — before running `add`, always check the `components` list from project context or list the `resolvedPaths.ui` directory. Don't import components that haven't been added, and don't re-add ones already installed.
|
|
172
|
+
3. **Find components** — `npx shadcn@latest search`.
|
|
173
|
+
4. **Get docs and examples** — run `npx shadcn@latest docs <component>` to get URLs, then fetch them. Use `npx shadcn@latest view` to browse registry items you haven't installed. To preview changes to installed components, use `npx shadcn@latest add --diff`.
|
|
174
|
+
5. **Install or update** — `npx shadcn@latest add`. When updating existing components, use `--dry-run` and `--diff` to preview changes first (see [Updating Components](#updating-components) below).
|
|
175
|
+
6. **Fix imports in third-party components** — After adding components from community registries (e.g. `@bundui`, `@magicui`), check the added non-UI files for hardcoded import paths like `@/components/ui/...`. These won't match the project's actual aliases. Use `npx shadcn@latest info` to get the correct `ui` alias (e.g. `@workspace/ui/components`) and rewrite the imports accordingly. The CLI rewrites imports for its own UI files, but third-party registry components may use default paths that don't match the project.
|
|
176
|
+
7. **Review added components** — After adding a component or block from any registry, **always read the added files and verify they are correct**. Check for missing sub-components (e.g. `SelectItem` without `SelectGroup`), missing imports, incorrect composition, or violations of the [Critical Rules](#critical-rules). Also replace any icon imports with the project's `iconLibrary` from the project context (e.g. if the registry item uses `lucide-react` but the project uses `hugeicons`, swap the imports and icon names accordingly). Fix all issues before moving on.
|
|
177
|
+
8. **Registry must be explicit** — When the user asks to add a block or component, **do not guess the registry**. If no registry is specified (e.g. user says "add a login block" without specifying `@shadcn`, `@tailark`, `owner/repo`, etc.), ask which registry to use. Never default to a registry on behalf of the user.
|
|
178
|
+
9. **Switching presets** — Ask the user first: **overwrite**, **partial**, **merge**, or **skip**?
|
|
179
|
+
- **Inspect current preset**: `npx shadcn@latest preset resolve`. Use `--json` when you need structured values.
|
|
180
|
+
- **Inspect incoming preset**: `npx shadcn@latest preset decode <code>`. Use `preset url <code>` or `preset open <code>` to share or open the preset builder.
|
|
181
|
+
- **Overwrite**: `npx shadcn@latest apply <code>`. Overwrites detected components, fonts, and CSS variables.
|
|
182
|
+
- **Partial**: `npx shadcn@latest apply <code> --only theme,font`. Updates only the selected preset parts without reinstalling UI components. Supported values are `theme` and `font`; comma-separated combinations are allowed. `icon` is intentionally not supported, because icon changes may require full component reinstall and transforms.
|
|
183
|
+
- **Merge**: `npx shadcn@latest init --preset <code> --force --no-reinstall`, then run `npx shadcn@latest info` to list installed components, then for each installed component use `--dry-run` and `--diff` to [smart merge](#updating-components) it individually.
|
|
184
|
+
- **Skip**: `npx shadcn@latest init --preset <code> --force --no-reinstall`. Only updates config and CSS, leaves components as-is.
|
|
185
|
+
- **Important**: Always run preset commands inside the user's project directory. `apply` only works in an existing project with a `components.json` file. The CLI automatically preserves the current base (`base` vs `radix`) from `components.json`. If you must use a scratch/temp directory (e.g. for `--dry-run` comparisons), pass `--base <current-base>` explicitly — preset codes do not encode the base.
|
|
186
|
+
|
|
187
|
+
## Updating Components
|
|
188
|
+
|
|
189
|
+
When the user asks to update a component from upstream while keeping their local changes, use `--dry-run` and `--diff` to intelligently merge. **NEVER fetch raw files from GitHub manually — always use the CLI.**
|
|
190
|
+
|
|
191
|
+
1. Run `npx shadcn@latest add <component> --dry-run` to see all files that would be affected.
|
|
192
|
+
2. For each file, run `npx shadcn@latest add <component> --diff <file>` to see what changed upstream vs local.
|
|
193
|
+
3. Decide per file based on the diff:
|
|
194
|
+
- No local changes → safe to overwrite.
|
|
195
|
+
- Has local changes → read the local file, analyze the diff, and apply upstream updates while preserving local modifications.
|
|
196
|
+
- User says "just update everything" → use `--overwrite`, but confirm first.
|
|
197
|
+
4. **Never use `--overwrite` without the user's explicit approval.**
|
|
198
|
+
|
|
199
|
+
## Quick Reference
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
# Create a new project.
|
|
203
|
+
npx shadcn@latest init --name my-app --preset base-nova
|
|
204
|
+
npx shadcn@latest init --name my-app --preset a2r6bw --template vite
|
|
205
|
+
|
|
206
|
+
# Create a monorepo project.
|
|
207
|
+
npx shadcn@latest init --name my-app --preset base-nova --monorepo
|
|
208
|
+
npx shadcn@latest init --name my-app --preset base-nova --template next --monorepo
|
|
209
|
+
|
|
210
|
+
# Initialize existing project.
|
|
211
|
+
npx shadcn@latest init --preset base-nova
|
|
212
|
+
npx shadcn@latest init --defaults # shortcut: --template=next --preset=nova (base style implied)
|
|
213
|
+
|
|
214
|
+
# Apply a preset to an existing project.
|
|
215
|
+
npx shadcn@latest apply a2r6bw
|
|
216
|
+
npx shadcn@latest apply a2r6bw --only theme
|
|
217
|
+
npx shadcn@latest apply a2r6bw --only font
|
|
218
|
+
npx shadcn@latest apply a2r6bw --only theme,font
|
|
219
|
+
|
|
220
|
+
# Inspect preset codes and project preset state.
|
|
221
|
+
npx shadcn@latest preset decode a2r6bw
|
|
222
|
+
npx shadcn@latest preset url a2r6bw
|
|
223
|
+
npx shadcn@latest preset open a2r6bw
|
|
224
|
+
npx shadcn@latest preset resolve
|
|
225
|
+
npx shadcn@latest preset resolve --json
|
|
226
|
+
|
|
227
|
+
# Add components.
|
|
228
|
+
npx shadcn@latest add button card dialog
|
|
229
|
+
npx shadcn@latest add @magicui/shimmer-button
|
|
230
|
+
npx shadcn@latest add owner/repo/item
|
|
231
|
+
npx shadcn@latest add --all
|
|
232
|
+
|
|
233
|
+
# Preview changes before adding/updating.
|
|
234
|
+
npx shadcn@latest add button --dry-run
|
|
235
|
+
npx shadcn@latest add button --diff button.tsx
|
|
236
|
+
npx shadcn@latest add @acme/form --view button.tsx
|
|
237
|
+
npx shadcn@latest add owner/repo/item --dry-run
|
|
238
|
+
|
|
239
|
+
# Search registries.
|
|
240
|
+
npx shadcn@latest search @shadcn -q "sidebar"
|
|
241
|
+
npx shadcn@latest search @tailark -q "stats"
|
|
242
|
+
npx shadcn@latest search owner/repo -q "login"
|
|
243
|
+
npx shadcn@latest search # all configured registries
|
|
244
|
+
npx shadcn@latest search @shadcn -q "menu" -t ui # filter by item type
|
|
245
|
+
|
|
246
|
+
# Get component docs and example URLs.
|
|
247
|
+
npx shadcn@latest docs button dialog select
|
|
248
|
+
|
|
249
|
+
# View registry item details (for items not yet installed).
|
|
250
|
+
npx shadcn@latest view @shadcn/button
|
|
251
|
+
npx shadcn@latest view owner/repo/item
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
**Named presets:** `nova`, `vega`, `maia`, `lyra`, `mira`, `luma`
|
|
255
|
+
**Templates:** `next`, `vite`, `start`, `react-router`, `astro` (all support `--monorepo`) and `laravel` (not supported for monorepo)
|
|
256
|
+
**Preset codes:** Version-prefixed base62 strings (e.g. `a2r6bw` or `b0`), from [ui.shadcn.com](https://ui.shadcn.com).
|
|
257
|
+
|
|
258
|
+
## Detailed References
|
|
259
|
+
|
|
260
|
+
- [rules/forms.md](./rules/forms.md) — FieldGroup, Field, InputGroup, ToggleGroup, FieldSet, validation states
|
|
261
|
+
- [rules/composition.md](./rules/composition.md) — Groups, overlays, Card, Tabs, Avatar, Alert, Empty, Toast, Separator, Skeleton, Badge, Button loading
|
|
262
|
+
- [rules/icons.md](./rules/icons.md) — data-icon, icon sizing, passing icons as objects
|
|
263
|
+
- [rules/styling.md](./rules/styling.md) — Semantic colors, variants, className, spacing, size, truncate, dark mode, cn(), z-index
|
|
264
|
+
- [rules/base-vs-radix.md](./rules/base-vs-radix.md) — asChild vs render, Select, ToggleGroup, Slider, Accordion
|
|
265
|
+
- [cli.md](./cli.md) — Commands, flags, presets, templates
|
|
266
|
+
- [registry.md](./registry.md) — Authoring source registries, `include`, item definitions, dependencies, GitHub registry rules
|
|
267
|
+
- [customization.md](./customization.md) — Theming, CSS variables, extending components
|
|
Binary file
|
|
Binary file
|