diff --git a/.env.exmaple b/.env.example similarity index 100% rename from .env.exmaple rename to .env.example diff --git a/README.md b/README.md index c5d5f4e..80866b1 100755 --- a/README.md +++ b/README.md @@ -8,8 +8,9 @@ The reason we need a separate repository is because when included in the landing ## How to run 1. Fork repository and clone -2. `npm install` -3. `npm run build` -4. `npm run serve` +2. Make a .env file in the root directory and copy over contents from .env.example +3. `npm install` +4. `npm run build` +5. `npm run serve` To run it with hot reload: `npm run start` diff --git a/docs/at-commands.md b/docs/at-commands.md new file mode 100644 index 0000000..99c27d6 --- /dev/null +++ b/docs/at-commands.md @@ -0,0 +1,138 @@ +--- +title: 🗃️ @ Commands +description: Context Providrrs for PearAI +keywords: [setup, install, context, providers, model] +--- + +# 🗃️ `@` Commands + +## How it works + +`@` Commands provide extra context (i.e. extra information) that can be included with your prompt to give the LLM more awareness of your work environment. To use this, type '@' inside the PearAI chat to see a dropdown containing a list of context options. Each context provider is a plugin, allowing you to reference an extra piece of information. + +As an example, you are having trouble running an app locally, and there's a bunch of errors in the terminal. You can use `@terminal` to include the error logs and further use `@files` to include `package.json` to immediately start debugging the problem. PearAI streamlines the debugging process by allowing you to gather a complete context all in one place. + + !![context](../static/img/context.webp) + +## Built-in Context Providers + +PearAI comes with a few useful context providers ready to use out of the box. If you wish to remove or add context providers, you can do so in `config.json`, under the `contextProviders` list. + +### `@Files` + +Allows you to specify a file as context. + +```json +{ + "contextProviders": [ + { + "name": "files" + } + ] +} +``` +### `@Codebase` + +Allows you to provide the codebase as context. Please note that depending on the size of your codebase, this may consume a lot of credits. + +```json +{ + "contextProviders": [ + { + "name": "codebase" + } + ] +} +``` +### `@Code` + +Allows you to specify functions/classes. + +```json +{ + "contextProviders": [ + { + "name": "code" + } + ] +} +``` +### `@Docs` + +Allows you to specify a documentation site as context. + +```json +{ + "contextProviders": [ + { + "name": "docs" + } + ] +} +``` +### `@Git Diff` + +This provides as context all the changes you've made on the current branch in reference to main. Use this to get a summary of your current work or to get a code review. + +```json +{ + "contextProviders": [ + { + "name": "diff" + } + ] +} +``` +### `@Terminal` + +Add your current terminal content as context. + +```json +{ + "contextProviders": [ + { + "name": "terminal" + } + ] +} +``` +### `@Problems` + +Adds the problems in your current file as context. + +```json +{ + "contextProviders": [ + { + "name": "problems" + } + ] +} +``` +### `@Folder` + +Reference everything within the specified folder as context. + +```json +{ + "contextProviders": [ + { + "name": "folder" + } + ] +} +``` + +### `@Directory Structure` + +Provides the project's directory structure as context. You can use this context to let the LLM know of any changes you've made to the directory. + +```json +{ + "contextProviders": [ + { + "name": "directory" + } + ] +} +``` diff --git a/docs/contributors.md b/docs/contributors.md index 99d8e15..6472f2b 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -14,6 +14,7 @@ We welcome contributions from the community! Whether you're fixing a bug, improv **Please review our coding [Contributing Guide](https://github.com/trypear/pearai-app/blob/main/CONTRIBUTING.md) to set up your coding environment.** For any questions, join the [PearAI Discord](https://discord.gg/7QMraJUsQt)! + For a complete onboarding to being a PearAI contributor, see this [onboarding presentation](https://docs.google.com/presentation/d/1zR9-7DTlb2PcsnapryZw8jHSkLTs9JxeXth4nyeemAQ/edit). For quick access to all links regarding PearAI, save this [Master Doc](https://docs.google.com/document/d/14jusGNbGRPT8X6GgEDbP1iab5q4X7_y-eFXK7Ky57IQ/edit#heading=h.4w42owbrw5n8). @@ -25,6 +26,12 @@ Curious about our stack? - PearAI backend is a Python FastAPI server with Supabase database. - Logging/Telemetry is done with Axiom. +## For Mac users: Download the Development Version of PearAI + +To run PearAI in development mode, you need to download the unnotarized version of the app since the notarized version cannot run in debug mode. + +[**Download Development Version of PearAI Here**](https://drive.google.com/drive/u/0/folders/1lxKEZG2iqee7L5PCPLwCSjcmQhDknJCW) + ## Contributors Thanks to this [list](https://github.com/trypear/pearai-app?tab=readme-ov-file#acknowledgements) of wonderful people who've contributed to PearAI! diff --git a/docs/quickstart.md b/docs/quickstart.md index 4f2b3d4..07e4893 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -16,10 +16,12 @@ keywords: [quickstart, start, install, vscode, jetbrains] ::: -