> For the complete documentation index, see [llms.txt](https://docs.reviactyl.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.reviactyl.app/development/extensions/getting-started.md). # Getting Started Getting Started with Reviactyl Extensions This page is for someone who has never built a panel extension before. By the end you'll have an extension scaffolded, linked into a running panel, and showing up in the extension list. ### What is an extension? An extension is a self-contained package that plugs extra behaviour into the panel. One extension can add any mix of: * **Frontend routes**: whole new pages in the dashboard or on a server's sidebar * **Frontend content**: small widgets injected into existing pages * **Backend routes**: new HTTP endpoints * **Artisan commands**: new `php artisan` commands * **Scheduler jobs**: tasks that run on the panel's schedule * **Boot-time PHP hooks**: code that runs when the panel starts Every extension is identified by a unique **ID** and described by a file called `extension.json`. The ID is how you refer to it everywhere: on the command line, in file paths, and on disk. ### What you need * A working Reviactyl panel you can run commands on. The docs assume the panel lives in `/var/www/reviactyl`. * Shell access to that directory, since extensions are managed through `php artisan`. * Basic comfort with PHP (for backend work) and React with TypeScript (for frontend work). You only need the half you plan to use. A local or staging panel is strongly recommended. Don't develop against production. ### Create your first extension From the panel directory, run: ```bash cd /var/www/reviactyl php artisan d:extensions:init ``` This creates the basic files for a new extension, starting with `extension.json`. If you'd rather start from something that already does a bit of everything, copy the community example instead: [reviactyl-community/example-extension](https://github.com/reviactyl-community/example-extension). It contains a backend route, two dashboard widgets, a dashboard page and several server pages. ### See it running While you're developing, you don't want to package and reinstall after every change. The dev command links your source folder into the panel instead: ```bash php artisan d:extensions:dev my-extension --enable ``` Replace `my-extension` with your extension's ID. This sets up two links: * `extensions/` points at your source directory * `public/extensions//frontend` points at your source `frontend` directory (if you have one) Because these are links rather than copies, edits show up without reinstalling. When you're finished, remove the links: ```bash php artisan d:extensions:dev my-extension --unlink ``` If your extension has frontend code, build it (see [Frontend Development](/development/extensions/frontend-development.md)). The short version: ```bash php artisan d:extensions:watch my-extension ``` ### Check that the panel knows about it These commands show what the panel thinks is going on: ```bash php artisan extensions:list php artisan extensions:info my-extension php artisan extensions:enable my-extension php artisan extensions:disable my-extension ``` An extension has to be **enabled** to do anything. If nothing seems to happen, start here. ### Checklist before you blame the system Most "it doesn't work" moments come down to one of these: * `extension.json` exists at the root of the extension. * `api_version` includes `RCYL_v26`. * Every frontend module referenced in the manifest actually exists. * Module paths in the manifest point to JavaScript files (`frontend/dist/*.js`) for runtime loading. See the note in [Frontend Development](/development/extensions/frontend-development.md). * The extension is enabled. * Nothing in the package contains path traversal (`../`). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.reviactyl.app/development/extensions/getting-started.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.