@framer/agent 0.0.0 → 0.0.29
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 +30 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +17144 -0
- package/dist/start-relay-server.d.ts +2 -0
- package/dist/start-relay-server.js +1669 -0
- package/docs/skills/framer-code-components.md +2526 -0
- package/docs/skills/framer-project.md +479 -0
- package/docs/skills/framer.md +78 -0
- package/package.json +40 -1
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Framer Agent CLI
|
|
2
|
+
|
|
3
|
+
CLI and agent skills for interacting with Framer projects via the Framer Server API.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install or refresh the globally available skills:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @framer/agent@latest setup
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
That installs skills into `~/.agents/skills` and `~/.claude/skills`.
|
|
14
|
+
|
|
15
|
+
## How It Works
|
|
16
|
+
|
|
17
|
+
The CLI and the installed skills are meant to work together. There are three skills:
|
|
18
|
+
|
|
19
|
+
- `framer` - the base meta skill that explains setup, project selection, and session creation.
|
|
20
|
+
- `framer-code-components` - explains specific prompts for how to write code components and provides examples.
|
|
21
|
+
- `framer-project-<project id>` - a dynamically-created skill for interacting with a specific project.
|
|
22
|
+
|
|
23
|
+
1. Running `npx @framer/agent@latest setup` will install the base `framer` and `framer-code-components` skills.
|
|
24
|
+
2. The frontmatter of `framer-code-components` tells agents to always load `framer` and the generated project skill first.
|
|
25
|
+
3. The frontmatter of `framer` tells agents to run `npx @framer/agent@latest setup` BEFORE loading the skill. This command will auto-update the cli and update the skill files.
|
|
26
|
+
4. Creating a new session for a project will create a `framer-project-<project id>` file. This file contains the latest agent system prompt from `framer.agent.getSystemPrompt` and the latest project context from `framer.agent.getContext`. Agents must load this project-specific skill immediately after creating a session before doing any connected-project work.
|
|
27
|
+
|
|
28
|
+
## Local Development
|
|
29
|
+
|
|
30
|
+
See the CONTRIBUTING.md file in this repository for local development instructions.
|
package/dist/cli.d.ts
ADDED