PearAI Documentation

repository·main·Indexed 20 days ago

https://github.com/trypear/pearai-app

PearAI is an open-source, AI-powered code editor built as a fork of VSCode, designed to provide deep context of the user's local codebase. This documentation covers built-in extensions and language features, including support for CSS, SCSS, LESS, HTML, and JSON, as well as integrations for Git, GitHub authentication, Jupyter Notebooks, and task runners like Grunt, Gulp, and Jake.

Tokens
106.2K
Snippets
353
Records
531
Agent score
72%

What's inside PearAI

  1. Overview of the Simple Browser extension

    main

    The Simple Browser extension provides a basic browser preview by embedding an iframe within a webview. It is designed primarily as a utility for other extensions to display simple web content within the editor environment.

    Note: This extension is bundled with the editor. While you can disable it, it cannot be uninstalled.

  2. Overview of PearAI

    main

    PearAI is an open-source, AI-powered code editor designed to reduce development time through seamless AI integration. It is a fork of VSCode, meaning users benefit from a familiar interface and existing VSCode workflows.

    Key features include:

    • Codebase Context: Pear has context on your local codebase, allowing you to ask questions directly about your code. For privacy, code is stored locally on your computer.
    • UI/UX Focus: Designed to make AI-assisted development as seamless as possible.
    • VSCode Compatibility: As a fork of VSCode, it maintains a familiar feel and ecosystem.
  3. Use Markdown Math rendering with KaTeX

    main

    The Markdown Math extension enables math rendering within VS Code's built-in Markdown preview and Markdown cells in notebooks. It uses KaTeX to process and display mathematical notation.

    Note: This extension is bundled with Visual Studio Code. You can disable it in your extensions settings, but you cannot uninstall it.

  4. Use GitHub features in PearAI/VS Code

    main

    The GitHub extension provides integrated workflows for managing repositories directly from the editor. Key capabilities include:

    • Publishing: Use the Publish to GitHub command to upload local projects to GitHub.
    • Cloning: The extension acts as a participant to the Git: Clone command, allowing you to clone repositories directly from GitHub.
    • Authentication: Handles GitHub authentication for built-in Git commands. This can be managed via the github.gitAuthentication command.
    • Automatic Forking: If you attempt to push to a repository where you lack write permissions, the extension automatically attempts to create a fork to facilitate the workflow.
  5. Understand the capabilities of the Search Result extension

    main

    The Search Result extension provides specialized language features specifically for the Search Results Editor. It enables the following capabilities when viewing search results within the editor:

    • Syntax Highlighting: Visual coloring of code within search result snippets.
    • Symbol Information: Recognition of code symbols within the results.
    • Result Highlighting: Visual emphasis on the specific text that matched the search query.
    • Go to Definition: The ability to navigate directly from a search result to the source code definition.

    Note: This extension is bundled with the editor. You can disable it in your settings, but it cannot be uninstalled.

  6. Understand Emmet integration in PearAI

    main

    Emmet is a built-in extension in PearAI (via the VS Code fork) that provides abbreviation expansion for HTML, CSS, and other languages.

    Note: Because this extension is bundled with the editor, you can disable it in your settings, but you cannot uninstall it.