Skip to content

Bang Commands

Note

For optimal performance and user experience, ensure that your RapidGPT extension settings allow access to the RAG features. If you have a Pro or Enterprise license and these features are not working, please check your extension settings to enable RAG access.

The !rag Command

The !rag command provides an efficient method to navigate and explore the Knowledge Base directly from the chat interface. To use it, simply type !rag in the chat input field and send the message.

Functionality

  • Displays the directory structure of the RapidGPT Knowledge Base
  • Allows users to view available resources at a glance
  • Facilitates easy exploration of the knowledge base contents

Usage Examples

  • !rag – Lists the top-level directory of the Knowledge Base.
  • !rag::<folder_path> – Displays the contents of a specified folder.
  • !rag::<file_path> – Fetches and displays the contents of a specific file.

The !ip Command

Warning

This is an experimental feature and currently only supports Xilinx IPs. The IP catalog’s default path is set to <rag_path>/xilinx. You can add or remove IP cores as needed. However, preserving the original directory structure is strongly recommended.

The !ip command offers a streamlined way to navigate and retrieve IP cores directly from the Knowledge Base. It provides both a comprehensive catalog of available cores and a mechanism to fetch the HDL source files for a selected core.

Functionality

  • Catalog Listing: When used without additional parameters, it displays a list of all available IP cores.
  • HDL Retrieval: By specifying an IP core name, it fetches the associated HDL source files (e.g., VHDL, Verilog).

Usage Examples

  • !ip: Retrieves a catalog of all available IP cores.
  • !ip::<ip-name> or !ip::"ip-name": Fetches HDL source files for the specified IP core.

The !docs Command

The !docs command simplifies the process of accessing detailed documentation for a specific IP core within the Knowledge Base. This includes various supportive documents that can assist with design and implementation.

Functionality

  • Documentation Retrieval: Fetches comprehensive files such as user guides, design notes, and other relevant documents for a chosen IP core.

Usage Example

  • !docs::<ip-name>: Retrieves the documentation (e.g., user guides, design notes) associated with the specified IP core.