Skip to main content

Command & Settings Reference

A lookup page for the VS Code commands, settings, guided prompts, and environment variables Forge provides.

VS Code commands

All commands are available from the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) under the Protrak Forge category. The import/export commands are also available from the Explorer right-click Protrak Forge submenu, which appears only inside a recognized Protrak project.

CommandWhat it does
Create New Protrak ProjectScaffold a fresh customization project (.csproj + Program.cs + schema folders) anywhere on disk
Generate TypeCreate a new Types/ entry interactively (lifecycle picker + multi-select attribute picker)
Import Schema from ServerDownload and apply schema from a Protrak server
Import Schema File into ProjectApply a local .json schema file to the project
Export Local Schema to ServerPush local schema files to a Protrak server
Export Local Schema to FileSave local schema as a .json file
Manage Server ConnectionsAdd, edit, or remove saved server connections (tokens stored in SecretStorage)
Set Protrak Project Root…Pick or browse to any folder and use it as the Protrak project root; bypasses auto-detection
Configure Agent InstructionsWrite agent-instruction files and MCP wiring for the AI tools you pick (Claude Code / GitHub Copilot / Codex), skipping anything that already exists. Also writes one Skill per customization area (programs, rules, widgets, notification templates, schema) as .claude/skills/forge-* (Claude Code/Codex) and .github/instructions/forge-*.instructions.md (Copilot) — see Skills
Create Project Skill…Scaffold a blank .claude/skills/<name>/SKILL.md for your own team's conventions, alongside the platform's forge-* skills — optionally give it a Copilot applyTo scope too — see Skills

Settings

SettingDefaultDescription
protrakForge.connections[]Saved server connections. Each entry has a name and url. Tokens are stored separately in SecretStorage.
protrakForge.import.deleteMissingFilesfalseOn All or Collection import, also delete local files not present in the incoming schema. Off by default (imports only write/overwrite). No effect on Element-scope imports.
protrakForge.projectRoot""Absolute path to the customization project. Overrides auto-detection; used by Forge commands and as PROTRAK_PROJECT_ROOT for the MCP server. Leave blank to auto-detect.
protrakForge.operationTimeoutMinutes10Maximum time server-bound operations (Import/Export from/to Server) may run before auto-cancelling. Increase for very large schemas.

Guided prompts

Named prompts you can invoke explicitly when you want a step-by-step flow (see Authoring with AI):

PromptPurpose
write-protrak-programGenerate a Protrak C# program — provide type, program type, and description
design-protrak-layoutDesign a Design Studio layout — provide type and mode (Create / Edit / View / Dashboard / Report / Relation)
scaffold-protrak-entityScaffold a new entity (Type + Lifecycle + Attributes + Relations)
design-protrak-ruleAuthor a business Rule from a natural-language description
write-protrak-widgetGenerate a custom-code (React) Widget

Environment variables

For non-VS-Code agents (Claude Code, Codex), set these in your MCP server config:

VariablePurposeDefault
PROTRAK_PROJECT_ROOTPath to your customization project (overrides workspace auto-detection)Auto-detect
PROTRAKFORGE_LOG_LEVELLog verbosity: DEBUG, INFO, or WARNINGINFO

Versions

The VS Code extension (prorigo.protrak-forge) and the npm MCP package (@prorigo/protrak-forge) are versioned together. The extension pins the MCP server to the matching major version, so patch and minor updates are picked up automatically without reinstalling the extension.