-
Notifications
You must be signed in to change notification settings - Fork 9
feat: Describe agents #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
Open
dawsontoth
wants to merge
1
commit into
main
Choose a base branch
from
agents
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+86
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| 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. | ||
|
|
||
|
dawsontoth marked this conversation as resolved.
|
||
| ## What You Will Learn | ||
|
|
||
| - How to install and run `harper-agent`, a purpose-built AI assistant for Harper development | ||
| - How to configure `harper-agent` with your preferred AI provider (Claude, ChatGPT, Gemini, or Ollama) | ||
| - How to use Harper Skills to improve general-purpose AI tools like Claude, ChatGPT, Cursor, or GitHub Copilot | ||
| - How to provide your AI tools with Harper-specific context for better code generation | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - An API key for your preferred AI provider. See the [harper-agent repository](https://github.com/HarperFast/harper-agent) for a list of supported providers and instructions for obtaining credentials. | ||
| - Node.js and npm installed on your system | ||
|
|
||
| ## Harper Agent | ||
|
|
||
| The `harper-agent` is an open source, 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. See its source code in the [`HarperFast/harper-agent`](https://github.com/HarperFast/harper-agent) repository. | ||
|
|
||
| ### 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 | ||
| ``` | ||
|
dawsontoth marked this conversation as resolved.
|
||
|
|
||
| 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.
|
||
|
|
||
| ## 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 in the [`HarperFast/skills`](https://github.com/HarperFast/skills) repository. | ||
|
|
||
| ### 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)**: Reference anything in your `skills/` directory to your conversation to provide the AI with immediate context. Some agents allow you to reference skills with `/` commands, like `/harper-best-practices`. | ||
| - **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. | ||
|
dawsontoth marked this conversation as resolved.
|
||
|
|
||
| ## Additional Resources | ||
|
|
||
| - [`HarperFast/harper-agent`](https://github.com/HarperFast/harper-agent) — Source code, documentation, and supported AI providers for the Harper Agent | ||
| - [`HarperFast/create-harper`](https://github.com/HarperFast/create-harper) — Bootstrap a new Harper project with skills included | ||
| - [`HarperFast/skills`](https://github.com/HarperFast/skills) — Browse the full collection of Harper Skills | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.