-
Notifications
You must be signed in to change notification settings - Fork 9
feat: Describe agents roughly #438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,68 @@ | ||||||||||
| --- | ||||||||||
| title: Using AI Agents | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| AI-powered development tools can significantly accelerate your workflow when building Harper applications. Whether you want a dedicated assistant or prefer using your favorite LLM, Harper provides the tools and context needed to make AI an effective part of your development process. | ||||||||||
|
|
||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a |
||||||||||
| ## Harper Agent | ||||||||||
|
|
||||||||||
| The `harper-agent` is a purpose-built AI assistant designed specifically for Harper development. It understands the Harper ecosystem and can help you with tasks ranging from project setup to debugging. | ||||||||||
|
|
||||||||||
| https://github.com/HarperFast/harper-agent | ||||||||||
|
Comment on lines
+9
to
+11
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ### Features | ||||||||||
|
|
||||||||||
| - **Application Creation**: Scaffold full Harper applications from natural language descriptions. | ||||||||||
| - **Code Generation**: Write schema definitions, custom functions, and integration code. | ||||||||||
| - **Diagnosis and Running**: Run your application and let the agent diagnose and fix errors. | ||||||||||
| - **Browser Control**: The agent can even interact with a browser to help you test and manage your applications. | ||||||||||
|
|
||||||||||
| ### Installation | ||||||||||
|
|
||||||||||
| Install the Harper Agent globally using npm: | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm install -g @harperfast/agent | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ### Usage | ||||||||||
|
|
||||||||||
| To start the agent, simply run: | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| harper-agent | ||||||||||
| ``` | ||||||||||
|
Comment on lines
+22
to
+34
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we really recommend global installation? Or should we recommend users to |
||||||||||
|
|
||||||||||
| On first run, it will help you configure your preferred AI model (Gemini, Claude, ChatGPT, or Ollama). Once configured, you can interact with it directly from your terminal. | ||||||||||
dawsontoth marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
|
||||||||||
| --- | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Skills: Empowering General-Purpose Agents | ||||||||||
|
|
||||||||||
| If you prefer using general-purpose AI tools like **Claude**, **ChatGPT**, **GitHub Copilot**, or **Cursor**, you can provide them with Harper-specific "Skills" to improve their accuracy and performance. | ||||||||||
|
|
||||||||||
| ### What are Skills? | ||||||||||
|
|
||||||||||
| Skills are a collection of Harper-specific context, documentation, and best practices. When an AI agent has access to these skills, it is much more likely to generate high-quality, idiomatic Harper code and follow current best practices. | ||||||||||
|
|
||||||||||
| ### Getting Skills | ||||||||||
|
|
||||||||||
| The easiest way to get Harper skills is by using the `create-harper` bootstrapper. When you create a new Harper project, a `skills/` directory is automatically included. | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm create harper@latest | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| You can also browse our ever evolving library of skills here: | ||||||||||
|
|
||||||||||
| https://github.com/HarperFast/create-harper/tree/main/templates-shared/all/skills | ||||||||||
|
Comment on lines
+56
to
+58
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't love raw links in documentation. I don't have a strong reason for why, but I find it better to link descriptive text instead. Maybe:
Suggested change
|
||||||||||
|
|
||||||||||
| ### How to use Skills | ||||||||||
|
|
||||||||||
| Once you have a `skills/` directory in your project, you can use it with your favorite AI tools: | ||||||||||
|
|
||||||||||
| - **Chat-based AI (Claude/ChatGPT)**: Upload the markdown files from the `skills/` directory to your conversation to provide the AI with immediate context. | ||||||||||
| - **IDE Extensions (Cursor/Copilot)**: Ensure these tools are indexing your project. They will automatically pick up the context from the `skills/` directory to provide better completions and chat responses. | ||||||||||
| - **Custom Agents**: If you are building your own AI-powered workflows, you can point your agent to these skills to give it specialized knowledge of Harper. | ||||||||||
|
|
||||||||||
| By leveraging these AI tools, you can move from idea to a running Harper application faster than ever before. | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This last line is a good succinct conclusion. Add a |
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a
## What You Will Learnsection after the intro para and before your main content that includes a bulleted list of learning outcomes for this guide.