winter-super-cli 2026.6.20 → 2026.6.22
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/memories/readme.md +35 -0
- package/package.json +6 -1
- package/resources/local/agents.md/AGENTS.md +43 -0
- package/resources/local/agents.md/LICENSE +21 -0
- package/resources/local/agents.md/README.md +49 -0
- package/resources/local/agents.md/components/AboutSection.tsx +37 -0
- package/resources/local/agents.md/components/CodeExample.tsx +207 -0
- package/resources/local/agents.md/components/CompatibilitySection.tsx +378 -0
- package/resources/local/agents.md/components/ExampleListSection.tsx +188 -0
- package/resources/local/agents.md/components/ExamplesSection.tsx +22 -0
- package/resources/local/agents.md/components/FAQSection.tsx +113 -0
- package/resources/local/agents.md/components/Footer.tsx +17 -0
- package/resources/local/agents.md/components/Hero.tsx +230 -0
- package/resources/local/agents.md/components/HowToUseSection.tsx +66 -0
- package/resources/local/agents.md/components/Section.tsx +44 -0
- package/resources/local/agents.md/components/ThreeCanvas.tsx +240 -0
- package/resources/local/agents.md/components/WhySection.tsx +64 -0
- package/resources/local/agents.md/components/icons/ClipboardIcon.tsx +27 -0
- package/resources/local/agents.md/components/icons/CopyIcon.tsx +15 -0
- package/resources/local/agents.md/components/icons/GitHubIcon.tsx +24 -0
- package/resources/local/agents.md/components/icons/LinkIcon.tsx +27 -0
- package/resources/local/agents.md/components/icons/UserIcon.tsx +27 -0
- package/resources/local/agents.md/next.config.ts +8 -0
- package/resources/local/agents.md/package.json +27 -0
- package/resources/local/agents.md/pages/_app.tsx +24 -0
- package/resources/local/agents.md/pages/_document.tsx +24 -0
- package/resources/local/agents.md/pages/index.tsx +160 -0
- package/resources/local/agents.md/pnpm-lock.yaml +2782 -0
- package/resources/local/agents.md/postcss.config.mjs +5 -0
- package/resources/local/agents.md/public/favicon-dark.png +0 -0
- package/resources/local/agents.md/public/favicon-light.png +0 -0
- package/resources/local/agents.md/public/favicon.ico +0 -0
- package/resources/local/agents.md/public/logos/aider.svg +16 -0
- package/resources/local/agents.md/public/logos/amp.svg +5 -0
- package/resources/local/agents.md/public/logos/augment.svg +9 -0
- package/resources/local/agents.md/public/logos/codex.svg +3 -0
- package/resources/local/agents.md/public/logos/copilot.svg +1 -0
- package/resources/local/agents.md/public/logos/cursor.svg +15 -0
- package/resources/local/agents.md/public/logos/devin-dark.svg +1 -0
- package/resources/local/agents.md/public/logos/devin-light.svg +1 -0
- package/resources/local/agents.md/public/logos/factory.svg +3 -0
- package/resources/local/agents.md/public/logos/gemini.svg +27 -0
- package/resources/local/agents.md/public/logos/goose.svg +12 -0
- package/resources/local/agents.md/public/logos/jules.svg +3 -0
- package/resources/local/agents.md/public/logos/junie.svg +5 -0
- package/resources/local/agents.md/public/logos/kilo-code.svg +43 -0
- package/resources/local/agents.md/public/logos/ona-dark.svg +3 -0
- package/resources/local/agents.md/public/logos/ona-light.svg +3 -0
- package/resources/local/agents.md/public/logos/opencode.svg +40 -0
- package/resources/local/agents.md/public/logos/phoenix.svg +44 -0
- package/resources/local/agents.md/public/logos/roocode.svg +3 -0
- package/resources/local/agents.md/public/logos/semgrep.svg +7 -0
- package/resources/local/agents.md/public/logos/uipath.svg +6 -0
- package/resources/local/agents.md/public/logos/vscode-dark.svg +19 -0
- package/resources/local/agents.md/public/logos/vscode-light.svg +12 -0
- package/resources/local/agents.md/public/logos/warp.svg +7 -0
- package/resources/local/agents.md/public/logos/windsurf-dark.svg +3 -0
- package/resources/local/agents.md/public/logos/windsurf-light.svg +3 -0
- package/resources/local/agents.md/public/logos/zed.svg +3 -0
- package/resources/local/agents.md/public/og.png +0 -0
- package/resources/local/agents.md/styles/globals.css +415 -0
- package/resources/local/agents.md/tsconfig.json +34 -0
- package/resources/local/awesome-design-md/README.md +197 -0
- package/resources/local/awesome-design-md/design-md/airbnb/DESIGN.md +545 -0
- package/resources/local/awesome-design-md/design-md/airbnb/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/airtable/DESIGN.md +554 -0
- package/resources/local/awesome-design-md/design-md/airtable/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/apple/DESIGN.md +562 -0
- package/resources/local/awesome-design-md/design-md/apple/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/binance/DESIGN.md +634 -0
- package/resources/local/awesome-design-md/design-md/binance/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/bmw/DESIGN.md +544 -0
- package/resources/local/awesome-design-md/design-md/bmw/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/bmw-m/DESIGN.md +503 -0
- package/resources/local/awesome-design-md/design-md/bmw-m/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/bugatti/DESIGN.md +454 -0
- package/resources/local/awesome-design-md/design-md/bugatti/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/cal/DESIGN.md +542 -0
- package/resources/local/awesome-design-md/design-md/cal/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/claude/DESIGN.md +589 -0
- package/resources/local/awesome-design-md/design-md/claude/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/clay/DESIGN.md +541 -0
- package/resources/local/awesome-design-md/design-md/clay/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/clickhouse/DESIGN.md +544 -0
- package/resources/local/awesome-design-md/design-md/clickhouse/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/cohere/DESIGN.md +451 -0
- package/resources/local/awesome-design-md/design-md/cohere/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/coinbase/DESIGN.md +570 -0
- package/resources/local/awesome-design-md/design-md/coinbase/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/composio/DESIGN.md +506 -0
- package/resources/local/awesome-design-md/design-md/composio/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/cursor/DESIGN.md +537 -0
- package/resources/local/awesome-design-md/design-md/cursor/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/elevenlabs/DESIGN.md +504 -0
- package/resources/local/awesome-design-md/design-md/elevenlabs/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/expo/DESIGN.md +526 -0
- package/resources/local/awesome-design-md/design-md/expo/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/ferrari/DESIGN.md +531 -0
- package/resources/local/awesome-design-md/design-md/ferrari/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/figma/DESIGN.md +578 -0
- package/resources/local/awesome-design-md/design-md/figma/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/framer/DESIGN.md +544 -0
- package/resources/local/awesome-design-md/design-md/framer/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/hashicorp/DESIGN.md +575 -0
- package/resources/local/awesome-design-md/design-md/hashicorp/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/ibm/DESIGN.md +550 -0
- package/resources/local/awesome-design-md/design-md/ibm/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/intercom/DESIGN.md +546 -0
- package/resources/local/awesome-design-md/design-md/intercom/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/kraken/DESIGN.md +125 -0
- package/resources/local/awesome-design-md/design-md/kraken/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/lamborghini/DESIGN.md +288 -0
- package/resources/local/awesome-design-md/design-md/lamborghini/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/linear.app/DESIGN.md +548 -0
- package/resources/local/awesome-design-md/design-md/linear.app/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/lovable/DESIGN.md +298 -0
- package/resources/local/awesome-design-md/design-md/lovable/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/mastercard/DESIGN.md +365 -0
- package/resources/local/awesome-design-md/design-md/mastercard/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/meta/DESIGN.md +683 -0
- package/resources/local/awesome-design-md/design-md/meta/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/minimax/DESIGN.md +746 -0
- package/resources/local/awesome-design-md/design-md/minimax/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/mintlify/DESIGN.md +852 -0
- package/resources/local/awesome-design-md/design-md/mintlify/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/miro/DESIGN.md +825 -0
- package/resources/local/awesome-design-md/design-md/miro/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/mistral.ai/DESIGN.md +773 -0
- package/resources/local/awesome-design-md/design-md/mistral.ai/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/mongodb/DESIGN.md +767 -0
- package/resources/local/awesome-design-md/design-md/mongodb/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/nike/DESIGN.md +575 -0
- package/resources/local/awesome-design-md/design-md/nike/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/notion/DESIGN.md +821 -0
- package/resources/local/awesome-design-md/design-md/notion/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/nvidia/DESIGN.md +640 -0
- package/resources/local/awesome-design-md/design-md/nvidia/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/ollama/DESIGN.md +539 -0
- package/resources/local/awesome-design-md/design-md/ollama/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/opencode.ai/DESIGN.md +521 -0
- package/resources/local/awesome-design-md/design-md/opencode.ai/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/pinterest/DESIGN.md +597 -0
- package/resources/local/awesome-design-md/design-md/pinterest/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/playstation/DESIGN.md +661 -0
- package/resources/local/awesome-design-md/design-md/playstation/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/posthog/DESIGN.md +690 -0
- package/resources/local/awesome-design-md/design-md/posthog/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/raycast/DESIGN.md +669 -0
- package/resources/local/awesome-design-md/design-md/raycast/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/renault/DESIGN.md +589 -0
- package/resources/local/awesome-design-md/design-md/renault/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/replicate/DESIGN.md +616 -0
- package/resources/local/awesome-design-md/design-md/replicate/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/resend/DESIGN.md +585 -0
- package/resources/local/awesome-design-md/design-md/resend/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/revolut/DESIGN.md +636 -0
- package/resources/local/awesome-design-md/design-md/revolut/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/runwayml/DESIGN.md +244 -0
- package/resources/local/awesome-design-md/design-md/runwayml/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/sanity/DESIGN.md +357 -0
- package/resources/local/awesome-design-md/design-md/sanity/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/sentry/DESIGN.md +262 -0
- package/resources/local/awesome-design-md/design-md/sentry/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/shopify/DESIGN.md +350 -0
- package/resources/local/awesome-design-md/design-md/shopify/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/spacex/DESIGN.md +194 -0
- package/resources/local/awesome-design-md/design-md/spacex/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/spotify/DESIGN.md +246 -0
- package/resources/local/awesome-design-md/design-md/spotify/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/starbucks/DESIGN.md +580 -0
- package/resources/local/awesome-design-md/design-md/starbucks/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/stripe/DESIGN.md +322 -0
- package/resources/local/awesome-design-md/design-md/stripe/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/supabase/DESIGN.md +255 -0
- package/resources/local/awesome-design-md/design-md/supabase/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/superhuman/DESIGN.md +252 -0
- package/resources/local/awesome-design-md/design-md/superhuman/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/tesla/DESIGN.md +286 -0
- package/resources/local/awesome-design-md/design-md/tesla/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/theverge/DESIGN.md +339 -0
- package/resources/local/awesome-design-md/design-md/theverge/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/together.ai/DESIGN.md +263 -0
- package/resources/local/awesome-design-md/design-md/together.ai/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/uber/DESIGN.md +295 -0
- package/resources/local/awesome-design-md/design-md/uber/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/vercel/DESIGN.md +310 -0
- package/resources/local/awesome-design-md/design-md/vercel/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/vodafone/DESIGN.md +423 -0
- package/resources/local/awesome-design-md/design-md/vodafone/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/voltagent/DESIGN.md +323 -0
- package/resources/local/awesome-design-md/design-md/voltagent/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/warp/DESIGN.md +253 -0
- package/resources/local/awesome-design-md/design-md/warp/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/webflow/DESIGN.md +92 -0
- package/resources/local/awesome-design-md/design-md/webflow/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/wired/DESIGN.md +278 -0
- package/resources/local/awesome-design-md/design-md/wired/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/wise/DESIGN.md +173 -0
- package/resources/local/awesome-design-md/design-md/wise/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/x.ai/DESIGN.md +257 -0
- package/resources/local/awesome-design-md/design-md/x.ai/README.md +5 -0
- package/resources/local/awesome-design-md/design-md/zapier/DESIGN.md +328 -0
- package/resources/local/awesome-design-md/design-md/zapier/README.md +5 -0
- package/resources/local/awesome-design-md/design-md-cli.js +167 -0
- package/resources/local/karpathy-tools/CLAUDE.md +65 -0
- package/resources/local/karpathy-tools/karpathy-md.js +140 -0
- package/scripts/audit-pack.js +21 -0
- package/skills/coding.md +87 -0
- package/skills/debug.md +63 -0
- package/skills/test.md +64 -0
- package/src/cli/tool-call-adapter.js +24 -2
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ❄️ Winter Memories
|
|
2
|
+
|
|
3
|
+
This directory stores cross-project knowledge and learnings.
|
|
4
|
+
|
|
5
|
+
## Memory Types
|
|
6
|
+
|
|
7
|
+
### Long-term Memory
|
|
8
|
+
Learned patterns, best practices, and project insights that persist across sessions.
|
|
9
|
+
|
|
10
|
+
### Project Memory
|
|
11
|
+
Project-specific knowledge including:
|
|
12
|
+
- Project structure
|
|
13
|
+
- Key files and their purposes
|
|
14
|
+
- Common workflows
|
|
15
|
+
- Team conventions
|
|
16
|
+
|
|
17
|
+
## Commands
|
|
18
|
+
|
|
19
|
+
- `/remember <text>` - Add a memory
|
|
20
|
+
- `/memories` - Show all memories
|
|
21
|
+
- `/memories search <query>` - Search memories
|
|
22
|
+
- `/forget <pattern>` - Remove memories
|
|
23
|
+
|
|
24
|
+
## Example Memories
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
- User prefers TypeScript over JavaScript
|
|
28
|
+
- This project uses React with Vite
|
|
29
|
+
- Database is PostgreSQL
|
|
30
|
+
- API is REST-based
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Storage
|
|
34
|
+
|
|
35
|
+
Memories are stored as JSON files in this directory, automatically organized by date and topic.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "winter-super-cli",
|
|
3
|
-
"version": "2026.6.
|
|
3
|
+
"version": "2026.6.22",
|
|
4
4
|
"description": "❄️ AI-Powered Development CLI with Interactive REPL",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "bin/winter.js",
|
|
@@ -16,10 +16,15 @@
|
|
|
16
16
|
"src/**/*.js",
|
|
17
17
|
"!src/**/*.test.js",
|
|
18
18
|
"resources/local/manifest.json",
|
|
19
|
+
"resources/local/agents.md/",
|
|
20
|
+
"resources/local/awesome-design-md/",
|
|
21
|
+
"resources/local/karpathy-tools/",
|
|
19
22
|
"resources/local/page-agent/",
|
|
20
23
|
"resources/local/ecc/",
|
|
21
24
|
"!resources/local/ecc/node_modules/**",
|
|
22
25
|
"!resources/local/ecc/package-lock.json",
|
|
26
|
+
"skills/",
|
|
27
|
+
"memories/",
|
|
23
28
|
"README.md",
|
|
24
29
|
"WINTER.md",
|
|
25
30
|
"CHANGELOG.md",
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# AGENTS Guidelines for This Repository
|
|
2
|
+
|
|
3
|
+
This repository contains a Next.js application located in the root of this repository. When
|
|
4
|
+
working on the project interactively with an agent (e.g. the Codex CLI) please follow
|
|
5
|
+
the guidelines below so that the development experience – in particular Hot Module
|
|
6
|
+
Replacement (HMR) – continues to work smoothly.
|
|
7
|
+
|
|
8
|
+
## 1. Use the Development Server, **not** `npm run build`
|
|
9
|
+
|
|
10
|
+
* **Always use `npm run dev` (or `pnpm dev`, `yarn dev`, etc.)** while iterating on the
|
|
11
|
+
application. This starts Next.js in development mode with hot-reload enabled.
|
|
12
|
+
* **Do _not_ run `npm run build` inside the agent session.** Running the production
|
|
13
|
+
build command switches the `.next` folder to production assets which disables hot
|
|
14
|
+
reload and can leave the development server in an inconsistent state. If a
|
|
15
|
+
production build is required, do it outside of the interactive agent workflow.
|
|
16
|
+
|
|
17
|
+
## 2. Keep Dependencies in Sync
|
|
18
|
+
|
|
19
|
+
If you add or update dependencies remember to:
|
|
20
|
+
|
|
21
|
+
1. Update the appropriate lockfile (`package-lock.json`, `pnpm-lock.yaml`, `yarn.lock`).
|
|
22
|
+
2. Re-start the development server so that Next.js picks up the changes.
|
|
23
|
+
|
|
24
|
+
## 3. Coding Conventions
|
|
25
|
+
|
|
26
|
+
* Prefer TypeScript (`.tsx`/`.ts`) for new components and utilities.
|
|
27
|
+
* Co-locate component-specific styles in the same folder as the component when
|
|
28
|
+
practical.
|
|
29
|
+
|
|
30
|
+
## 4. Useful Commands Recap
|
|
31
|
+
|
|
32
|
+
| Command | Purpose |
|
|
33
|
+
| ------------------ | -------------------------------------------------- |
|
|
34
|
+
| `npm run dev` | Start the Next.js dev server with HMR. |
|
|
35
|
+
| `npm run lint` | Run ESLint checks. |
|
|
36
|
+
| `npm run test` | Execute the test suite (if present). |
|
|
37
|
+
| `npm run build` | **Production build – _do not run during agent sessions_** |
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
Following these practices ensures that the agent-assisted development workflow stays
|
|
42
|
+
fast and dependable. When in doubt, restart the dev server rather than running the
|
|
43
|
+
production build.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 OpenAI
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
[AGENTS.md](https://agents.md) is a simple, open format for guiding coding agents.
|
|
6
|
+
|
|
7
|
+
Think of AGENTS.md as a README for agents: a dedicated, predictable place
|
|
8
|
+
to provide context and instructions to help AI coding agents work on your project.
|
|
9
|
+
|
|
10
|
+
Below is a minimal example of an AGENTS.md file:
|
|
11
|
+
|
|
12
|
+
```markdown
|
|
13
|
+
# Sample AGENTS.md file
|
|
14
|
+
|
|
15
|
+
## Dev environment tips
|
|
16
|
+
- Use `pnpm dlx turbo run where <project_name>` to jump to a package instead of scanning with `ls`.
|
|
17
|
+
- Run `pnpm install --filter <project_name>` to add the package to your workspace so Vite, ESLint, and TypeScript can see it.
|
|
18
|
+
- Use `pnpm create vite@latest <project_name> -- --template react-ts` to spin up a new React + Vite package with TypeScript checks ready.
|
|
19
|
+
- Check the name field inside each package's package.json to confirm the right name—skip the top-level one.
|
|
20
|
+
|
|
21
|
+
## Testing instructions
|
|
22
|
+
- Find the CI plan in the .github/workflows folder.
|
|
23
|
+
- Run `pnpm turbo run test --filter <project_name>` to run every check defined for that package.
|
|
24
|
+
- From the package root you can just call `pnpm test`. The commit should pass all tests before you merge.
|
|
25
|
+
- To focus on one step, add the Vitest pattern: `pnpm vitest run -t "<test name>"`.
|
|
26
|
+
- Fix any test or type errors until the whole suite is green.
|
|
27
|
+
- After moving files or changing imports, run `pnpm lint --filter <project_name>` to be sure ESLint and TypeScript rules still pass.
|
|
28
|
+
- Add or update tests for the code you change, even if nobody asked.
|
|
29
|
+
|
|
30
|
+
## PR instructions
|
|
31
|
+
- Title format: [<project_name>] <Title>
|
|
32
|
+
- Always run `pnpm lint` and `pnpm test` before committing.
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Website
|
|
36
|
+
|
|
37
|
+
This repository also includes a basic Next.js website hosted at https://agents.md/
|
|
38
|
+
that explains the project’s goals in a simple way, and featuring some examples.
|
|
39
|
+
|
|
40
|
+
### Running the app locally
|
|
41
|
+
1. Install dependencies:
|
|
42
|
+
```bash
|
|
43
|
+
pnpm install
|
|
44
|
+
```
|
|
45
|
+
2. Start the development server:
|
|
46
|
+
```bash
|
|
47
|
+
pnpm run dev
|
|
48
|
+
```
|
|
49
|
+
3. Open your browser and go to http://localhost:3000
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import Section from "@/components/Section";
|
|
2
|
+
|
|
3
|
+
const AboutSection = () => (
|
|
4
|
+
<Section title="About" className="pb-0" center maxWidthClass="max-w-3xl">
|
|
5
|
+
<p className="max-w-3xl">
|
|
6
|
+
AGENTS.md emerged from collaborative efforts across the AI software
|
|
7
|
+
development ecosystem, including{" "}
|
|
8
|
+
<a href="https://openai.com/codex/" className="underline hover:no-underline" target="_blank" rel="noopener noreferrer">OpenAI Codex</a>,{" "}
|
|
9
|
+
<a href="https://ampcode.com" className="underline hover:no-underline" target="_blank" rel="noopener noreferrer">Amp</a>,{" "}
|
|
10
|
+
<a href="https://jules.google" className="underline hover:no-underline" target="_blank" rel="noopener noreferrer">Jules from Google</a>,{" "}
|
|
11
|
+
<a href="https://cursor.com" className="underline hover:no-underline" target="_blank" rel="noopener noreferrer">Cursor</a>, and{" "}
|
|
12
|
+
<a href="https://factory.ai" className="underline hover:no-underline" target="_blank" rel="noopener noreferrer">Factory</a>.
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p className="max-w-3xl mt-4">
|
|
16
|
+
We’re committed to helping maintain and evolve this as an open format that benefits the entire developer community,
|
|
17
|
+
regardless of which coding agent you use.
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
<p className="max-w-3xl mt-4">
|
|
21
|
+
AGENTS.md is now stewarded by the{" "}
|
|
22
|
+
<a href="https://aaif.io" className="underline hover:no-underline">
|
|
23
|
+
Agentic AI Foundation
|
|
24
|
+
</a>{" "}
|
|
25
|
+
under the Linux Foundation.{" "}
|
|
26
|
+
<a
|
|
27
|
+
href="https://openai.com/index/agentic-ai-foundation/"
|
|
28
|
+
className="underline hover:no-underline"
|
|
29
|
+
>
|
|
30
|
+
Learn more →
|
|
31
|
+
</a>
|
|
32
|
+
</p>
|
|
33
|
+
|
|
34
|
+
</Section>
|
|
35
|
+
);
|
|
36
|
+
|
|
37
|
+
export default AboutSection;
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import ClipboardIcon from "./icons/ClipboardIcon";
|
|
3
|
+
import CopyIcon from "./icons/CopyIcon";
|
|
4
|
+
|
|
5
|
+
interface CodeExampleProps {
|
|
6
|
+
/** Markdown content to display; falls back to default example if not provided */
|
|
7
|
+
code?: string;
|
|
8
|
+
/** Optional URL for "View on GitHub" link */
|
|
9
|
+
href?: string;
|
|
10
|
+
/** If true, render only the code block without the section wrapper */
|
|
11
|
+
compact?: boolean;
|
|
12
|
+
/** Override Tailwind height classes for the <pre> block */
|
|
13
|
+
heightClass?: string;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* When true, vertically center the content and copy button – useful for
|
|
17
|
+
* single-line shell commands shown inside a short container (e.g. FAQ).
|
|
18
|
+
*/
|
|
19
|
+
centerVertically?: boolean;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export const HERO_AGENTS_MD = `# AGENTS.md
|
|
23
|
+
|
|
24
|
+
## Setup commands
|
|
25
|
+
- Install deps: \`pnpm install\`
|
|
26
|
+
- Start dev server: \`pnpm dev\`
|
|
27
|
+
- Run tests: \`pnpm test\`
|
|
28
|
+
|
|
29
|
+
## Code style
|
|
30
|
+
- TypeScript strict mode
|
|
31
|
+
- Single quotes, no semicolons
|
|
32
|
+
- Use functional patterns where possible`;
|
|
33
|
+
|
|
34
|
+
const EXAMPLE_AGENTS_MD = `# Sample AGENTS.md file
|
|
35
|
+
|
|
36
|
+
## Dev environment tips
|
|
37
|
+
- Use \`pnpm dlx turbo run where <project_name>\` to jump to a package instead \
|
|
38
|
+
of scanning with \`ls\`.
|
|
39
|
+
- Run \`pnpm install --filter <project_name>\` to add the package to your \
|
|
40
|
+
workspace so Vite, ESLint, and TypeScript can see it.
|
|
41
|
+
- Use \`pnpm create vite@latest <project_name> -- --template react-ts\` to \
|
|
42
|
+
spin up a new React + Vite package with TypeScript checks ready.
|
|
43
|
+
- Check the name field inside each package's package.json to confirm the \
|
|
44
|
+
right name—skip the top-level one.
|
|
45
|
+
|
|
46
|
+
## Testing instructions
|
|
47
|
+
- Find the CI plan in the .github/workflows folder.
|
|
48
|
+
- Run \`pnpm turbo run test --filter <project_name>\` to run every check \
|
|
49
|
+
defined for that package.
|
|
50
|
+
- From the package root you can just call \`pnpm test\`. The commit should \
|
|
51
|
+
pass all tests before you merge.
|
|
52
|
+
- To focus on one step, add the Vitest pattern: \`pnpm vitest run -t "<test \
|
|
53
|
+
name>"\`.
|
|
54
|
+
- Fix any test or type errors until the whole suite is green.
|
|
55
|
+
- After moving files or changing imports, run \`pnpm lint --filter \
|
|
56
|
+
<project_name>\` to be sure ESLint and TypeScript rules still pass.
|
|
57
|
+
- Add or update tests for the code you change, even if nobody asked.
|
|
58
|
+
|
|
59
|
+
## PR instructions
|
|
60
|
+
- Title format: [<project_name>] <Title>
|
|
61
|
+
- Always run \`pnpm lint\` and \`pnpm test\` before committing.`;
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Very lightly highlight the Markdown without fully parsing it.
|
|
65
|
+
*/
|
|
66
|
+
function parseMarkdown(md: string): React.ReactNode[] {
|
|
67
|
+
const lines = md.split("\n");
|
|
68
|
+
const elements: React.ReactNode[] = [];
|
|
69
|
+
|
|
70
|
+
for (let i = 0; i < lines.length; i++) {
|
|
71
|
+
const line = lines[i];
|
|
72
|
+
|
|
73
|
+
// Handle headers
|
|
74
|
+
if (line.startsWith("# ") || line.startsWith("## ") || line.startsWith("### ")) {
|
|
75
|
+
elements.push(
|
|
76
|
+
<div key={i} className="font-bold">
|
|
77
|
+
{line}
|
|
78
|
+
</div>
|
|
79
|
+
);
|
|
80
|
+
} else if (line.startsWith("- ")) {
|
|
81
|
+
// Handle list items with inline code
|
|
82
|
+
elements.push(
|
|
83
|
+
<div key={i}>
|
|
84
|
+
{renderLineWithInlineCode(line)}
|
|
85
|
+
</div>
|
|
86
|
+
);
|
|
87
|
+
} else if (line.trim() === "") {
|
|
88
|
+
// Handle empty lines
|
|
89
|
+
elements.push(<div key={i}> </div>);
|
|
90
|
+
} else {
|
|
91
|
+
// Handle regular lines with inline code
|
|
92
|
+
elements.push(
|
|
93
|
+
<div key={i}>
|
|
94
|
+
{renderLineWithInlineCode(line)}
|
|
95
|
+
</div>
|
|
96
|
+
);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return elements;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Render a line with inline code highlighting
|
|
105
|
+
*/
|
|
106
|
+
function renderLineWithInlineCode(line: string): React.ReactNode {
|
|
107
|
+
const parts = line.split(/(`[^`]+`)/g);
|
|
108
|
+
|
|
109
|
+
return parts.map((part, index) => {
|
|
110
|
+
if (part.startsWith("`") && part.endsWith("`")) {
|
|
111
|
+
// This is inline code
|
|
112
|
+
return (
|
|
113
|
+
<span key={index} className="bg-gray-200 dark:bg-gray-800 px-1 rounded">
|
|
114
|
+
{part}
|
|
115
|
+
</span>
|
|
116
|
+
);
|
|
117
|
+
}
|
|
118
|
+
// Regular text
|
|
119
|
+
return part;
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Markdown block for AGENTS.md examples.
|
|
125
|
+
*/
|
|
126
|
+
export default function CodeExample({
|
|
127
|
+
code,
|
|
128
|
+
href,
|
|
129
|
+
compact = false,
|
|
130
|
+
heightClass,
|
|
131
|
+
centerVertically = false,
|
|
132
|
+
}: CodeExampleProps) {
|
|
133
|
+
const md = code ?? EXAMPLE_AGENTS_MD;
|
|
134
|
+
const [copied, setCopied] = React.useState(false);
|
|
135
|
+
|
|
136
|
+
const copyToClipboard = async () => {
|
|
137
|
+
try {
|
|
138
|
+
await navigator.clipboard.writeText(md);
|
|
139
|
+
setCopied(true);
|
|
140
|
+
setTimeout(() => setCopied(false), 2000);
|
|
141
|
+
} catch (err) {
|
|
142
|
+
console.error("Failed to copy to clipboard:", err);
|
|
143
|
+
}
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
const content = (
|
|
147
|
+
<>
|
|
148
|
+
<div className="relative">
|
|
149
|
+
<button
|
|
150
|
+
onClick={copyToClipboard}
|
|
151
|
+
className={`absolute right-3 p-2 rounded-md bg-transparent text-gray-800 dark:text-gray-200 hover:bg-gray-100 dark:hover:bg-gray-800 transition-colors z-10 cursor-pointer ${
|
|
152
|
+
centerVertically ? "top-1/2 -translate-y-1/2" : "top-3"
|
|
153
|
+
}`}
|
|
154
|
+
aria-label="Copy to clipboard"
|
|
155
|
+
>
|
|
156
|
+
{copied ? (
|
|
157
|
+
<svg
|
|
158
|
+
className="w-4 h-4"
|
|
159
|
+
fill="none"
|
|
160
|
+
stroke="currentColor"
|
|
161
|
+
viewBox="0 0 24 24"
|
|
162
|
+
>
|
|
163
|
+
<path
|
|
164
|
+
strokeLinecap="round"
|
|
165
|
+
strokeLinejoin="round"
|
|
166
|
+
strokeWidth={2}
|
|
167
|
+
d="M5 13l4 4L19 7"
|
|
168
|
+
/>
|
|
169
|
+
</svg>
|
|
170
|
+
) : (
|
|
171
|
+
<CopyIcon className="w-4 h-4" />
|
|
172
|
+
)}
|
|
173
|
+
</button>
|
|
174
|
+
<pre
|
|
175
|
+
className={`relative rounded-lg bg-white dark:bg-black text-gray-800 dark:text-gray-100 text-xs leading-6 overflow-x-auto p-4 ${
|
|
176
|
+
centerVertically ? "flex items-center" : ""
|
|
177
|
+
} ${
|
|
178
|
+
heightClass
|
|
179
|
+
? heightClass
|
|
180
|
+
: compact
|
|
181
|
+
? ""
|
|
182
|
+
: "min-h-[250px] max-h-[500px]"
|
|
183
|
+
} border border-gray-200 dark:border-gray-700 shadow-sm`}
|
|
184
|
+
>
|
|
185
|
+
<code>
|
|
186
|
+
{parseMarkdown(md)}
|
|
187
|
+
</code>
|
|
188
|
+
</pre>
|
|
189
|
+
</div>
|
|
190
|
+
</>
|
|
191
|
+
);
|
|
192
|
+
|
|
193
|
+
if (compact) {
|
|
194
|
+
return <div className="w-full">{content}</div>;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
return (
|
|
198
|
+
<section className="px-6 pt-10 pb-24 bg-gray-50 dark:bg-gray-900/40">
|
|
199
|
+
<div className="max-w-5xl mx-auto flex flex-col gap-6">
|
|
200
|
+
<h2 className="text-3xl font-semibold tracking-tight">
|
|
201
|
+
AGENTS.md in action
|
|
202
|
+
</h2>
|
|
203
|
+
{content}
|
|
204
|
+
</div>
|
|
205
|
+
</section>
|
|
206
|
+
);
|
|
207
|
+
}
|