Vela, our next-generation charting platform, is live at vela.luxalgo.com.
LuxAlgo

Coding agents

Configure AI coding agents with the skills included in the Vela Pro repository, alongside the skills for Vela's open-source core and UI kit.

View as Markdown

The Vela Pro repository ships agent skills alongside the source code they document. Each skill is a directory containing a SKILL.md file with targeted instructions, API rules, and verification checks that an AI coding agent loads when configuring a module, mounting a widget, or implementing a port.

Available skills

Three root-level skills cover cross-module workflows, and each of the six domain modules ships a dedicated skill directory. In the codebase and API, modules are referred to as plugins and live under plugins/.

SkillRepository pathScope
using-vela-pro-modulesskills/using-vela-pro-modules/Enabling and configuring modules, cross-module coordination, controllers and ports, authoring custom modules, and diagnosing missing panels
composing-vela-pro-widgetsskills/composing-vela-pro-widgets/Building custom pages from multiple standalone widgets, mounting widgets inside custom panels, linking widgets to each other and to charts, and custom styling
editing-vela-pro-modulesskills/editing-vela-pro-modules/Modifying modules or widgets inside the Vela Pro repository and adding new module packages
using-vela-pro-watchlistplugins/watchlist/skills/using-vela-pro-watchlist/Watchlist configuration, standalone createWatchlist and createWatchlistView, server-side list persistence (WatchlistStorage), custom quote feeds (QuoteSource), and custom row actions
using-vela-pro-alertsplugins/alerts/skills/using-vela-pro-alerts/Price and script alerts, programmatic alert creation and management, createAlertsList, server-side alert storage (AlertsBackend), and routing alert events via onFire and webhooks
using-vela-pro-order-bookplugins/dom/skills/using-vela-pro-order-book/Order book, DOM ladder, and trades tape views, createOrderBook, ladder order entry, and custom market depth feeds (DepthFeed)
using-vela-pro-tradingplugins/trading/skills/using-vela-pro-trading/Trading configuration, programmatic order placement and cancellation, createOrderTicket and createTradingPanel, and live broker integration via the Broker port
using-vela-pro-journalplugins/journal/skills/using-vela-pro-journal/Journal setup, trade fill imports, createJournalPanel and createJournalView, and server-side persistence (JournalStore)
using-vela-pro-calendarplugins/calendar/skills/using-vela-pro-calendar/Economic calendar setup and configuration, standalone createCalendar, and implementing CalendarSource

The order book skill is located under plugins/dom/ because its package name is @luxalgo/vela-pro-dom. The trading skill also includes the complete Broker contract specification in references/broker.md beside its SKILL.md.

Installing skills

Because the skills live directly inside your local Vela Pro clone, no separate download is needed. How you expose them depends on your coding agent:

  • If your agent loads skills from a local skills directory, copy or symlink the nine skill folders into that directory.
  • If your agent reads a project instructions file (such as AGENTS.md or CLAUDE.md), reference the skill locations in that file:
## Vela Pro

Vela Pro is cloned at ../vela-pro. Before writing code that uses Vela Pro, read the matching
skill: ../vela-pro/skills/<skill>/SKILL.md for cross-module tasks, and
../vela-pro/plugins/<module>/skills/<skill>/SKILL.md for module-specific work.

To install or build Vela Pro, follow https://docs.luxalgo.com/vela-pro/get-started/setup.

Replace ../vela-pro with the path to your clone, and note project-specific details such as where your custom data provider lives and which modules your application enables.

The repository README.md also documents npx skills add LuxAlgo/Vela-pro via the open-source skills CLI. Because LuxAlgo/Vela-pro is a private repository, your environment must have GitHub read access to run that command.

If package installation steps inside a skill differ from Installation, follow Installation. That guide is the reference workflow when building and consuming Vela Pro from a local clone.

Core and UI kit skills

Vela Pro builds on Vela's open-source core (@luxalgo/vela) and its UI kit (@luxalgo/vela-ui), both of which ship dedicated agent skills. Those skills cover charts and workspaces, data providers, indicators and scripting engines, drawing tools, the plugin SDK, UI kit components, and theming. Vela Pro skills reference them directly by name, including extending-vela-with-plugins for custom panels or chart types and using-vela-ui-components for UI kit primitives.

See Coding agents in the core documentation for the full list of core and UI kit skills and installation instructions.

LLM-ready documentation

Skills are versioned in Git alongside the code they document. Checking out a release tag provides the skill definitions and typechecked TypeScript examples matching that exact version. Each module also includes a README.md beside its skill directory (plugins/<module>/README.md) documenting all module options, widget props, and port interfaces.

Every page on this documentation site also includes Copy for LLM and View as Markdown buttons beneath the page title. Machine-readable indexes of the documentation are served at llms.txt and llms-full.txt.

On this page