CRMScript IDE

An offline IDE for customising SuperOffice CRM with its CRMScript language.

Features

• Project management
  • Login to your online tenant of SuperOffice to get access to the scripts. Command "Cirrus: Login" (Ctrl+Shift+P to open commandline)
  • Download/update CRMScripts from the remote tenant into a local project. Command "Cirrus: Download scripts to the current folder". NB: Your local changes may be overwritten.
  • Editing the meta-information and script source code
  • Create new scripts inside the local project
  • Delete a script
  • Upload scripts into the tenant. Command "Cirrus: Upload all in the current folder".
  • Execute the Script opened in the current editor. Command "Cirrus: Execute the current script". Results will be shown in OUTPUT->CRMSCript
• CRMScript editor
  • Syntax highlighting
  • CompletionItems for Base Variables/Classes
  • CompletiomItems for methods
  • CompletionItems for variables defined in the code
  • Update intellisense from github.com/superoffice-docs on startup
• Built-in features by Visual Studio Code
  • Source control (Git)
  • Code search, find, replace
  • Snippets (only user-defined snippets so far)
  • ...

Install from source code

• git clone https://github.com/SuperOffice/vscode-crmscript
• cd vscode-crmscript
• npm install
• npm run compile
• Open VS Code from this folder (e.g., code .)
• Debug -> Client + Server -> Start Debugging (F5)

Install from binary

• Download vsix package: https://github.com/SuperOffice/vscode-crmscript/releases/download/0.0.1/crmscript-0.0.1.vsix
• Open VS Code, run command "Extensions: Install from VSIX"
  • Alternatively open Extensions (Ctrl+Shift+X), use Actions-menu at top of Extensions panel, and choose "Install from VSIX..."

Quick start

In Visual Studio Code (with the CRMScript extension):

• Open an empty folder (File -> Open Folder...)
• Create a file named "client.json" in this folder
• Write the following content into that file. The Client ID and Client Secret are specific to the tenant and can be found online.

{
    "id": "<Client ID>",
    "secret": "<Client Secret>"
}

• Login. Command: "Cirrus: Login"
• Download the default system scripts. Command: "Cirrus: Download scripts to the current folder"