Skip to main content
Maximo Local Dev

Installation Guide

Get up and running in minutes with our automated installer

Quick Install

The fastest way to install the Maximo Developer Configuration Tools extension. Choose your editor and run the one-line command to install automatically.

For IBM Bob IDE Bob IDE
Installation Command 
curl -fsSL https://ibm-mas.github.io/maf-local-dev-mode/scripts/install.sh | bash -s bob

Installs directly into IBM Bob IDE without prompts. Requires the bobide CLI to be available in your PATH.

For VSCode VSCode
Installation Command 
curl -fsSL https://ibm-mas.github.io/maf-local-dev-mode/scripts/install.sh | bash -s vscode

Installs directly into VSCode without prompts. Requires the code CLI to be available in your PATH.

Interactive Mode Auto-Detect
Installation Command 
curl -fsSL https://ibm-mas.github.io/maf-local-dev-mode/scripts/install.sh | bash

Automatically detects available editors and prompts you to choose if multiple are found.

ℹī¸
What these commands do:
  • â€ĸ Check for prerequisites (editor CLI, Node.js)
  • â€ĸ Download the latest .vsix from GitHub releases
  • â€ĸ Install the extension automatically into your chosen editor
  • â€ĸ Provide verification steps and next actions

Note: The bash -s bob or bash -s vscode syntax passes the editor choice as a parameter to the installation script, enabling non-interactive installation.

Easiest Method: Use Your Coding Assistant!

Having trouble with the code command not being in your PATH? Simply paste the installation command into your coding assistant (VSCode Copilot, GitHub Copilot Chat, Bob IDE, or similar AI assistants).

Why This Works:

  • Your coding assistant has access to the editor's internal commands
  • No need to manually install the code command in PATH
  • Works even if you're new to command-line tools
  • The assistant can detect and use the editor's full application path
Copy and paste this into your coding assistant 
curl -fsSL https://ibm-mas.github.io/maf-local-dev-mode/scripts/install.sh | bash -s vscode

For Bob IDE users: Replace vscode with bobide in the command above.

Prerequisites

Before installing, ensure you have the following requirements met:

Code Editor

IBM Bob IDE or VSCode

The extension works with IBM Bob IDE (bobide CLI) or VSCode (code CLI). At least one must be installed with its CLI available in your PATH.

Download IBM Bob

Node.js

Version 20.0.0 or higher

Required for running the preview server and development tools.

Download Node.js

Git

Any recent version

Optional but recommended for version control and cloning repositories.

Download Git

Step-by-Step Installation

Prefer to install manually? Follow these detailed steps.

1

Download the Installation Script

Download the installer script to your local machine:

Download Script 
curl -fsSL https://ibm-mas.github.io/maf-local-dev-mode/scripts/install.sh -o install.sh
chmod +x install.sh
2

Run the Installer

Execute the installation script. You can specify your editor or let it auto-detect:

For Bob IDE 
./install.sh bob
For VSCode 
./install.sh vscode
Interactive (auto-detect) 
./install.sh

The script will check prerequisites, download the latest release, and install the extension into your chosen editor.

3

Verify Installation

Restart VSCode and verify the extension is installed:

  1. 1 Open VSCode
  2. 2 Press Ctrl+Shift+X (or Cmd+Shift+X on Mac)
  3. 3 Search for "Maximo Developer Configuration Tools"
  4. 4 Verify it shows as installed
4

Configure Authentication

Set up authentication for your Maximo environment:

Local Manage: No additional setup required
→
Remote MAS: Follow OIDC setup in the plugin

Alternative Installation Methods

VSCode Marketplace

Install directly from the VSCode Extensions Marketplace (coming soon).

1. Open VSCode

2. Go to Extensions (Ctrl+Shift+X)

3. Search for "Maximo Developer Configuration Tools"

4. Click Install

Coming Soon

Manual VSIX Install

Download and install the .vsix file manually.

1. Download .vsix from GitHub Releases

2. Open VSCode

3. Extensions → "..." menu → "Install from VSIX..."

4. Select the downloaded .vsix file

Detailed Instructions

Command Line Install

Install using the VSCode CLI directly.

CLI Install 
code --install-extension maximo-developer-configuration-tools.vsix

Replace the filename with your downloaded .vsix file path.

Troubleshooting

Installation script fails with "code command not found" â–ŧ
Easiest Solution: Use Your Coding Assistant!

Simply paste the installation command into your coding assistant (VSCode Copilot, GitHub Copilot Chat, Bob IDE, or similar). The assistant has access to the editor's internal commands and can install the extension without needing the code command in your PATH.

See the Coding Assistant section above for details.

Alternative: Manually install the code command

If you prefer to fix the PATH issue manually:

  1. 1. Open VSCode
  2. 2. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
  3. 3. Type "Shell Command: Install 'code' command in PATH"
  4. 4. Select and run the command
  5. 5. Restart your terminal and try again
Node.js version is too old â–ŧ

The extension requires Node.js 20.0.0 or higher. Update Node.js:

  • â€ĸ Using nvm: nvm install 20 && nvm use 20
  • â€ĸ Direct download: Visit nodejs.org
  • â€ĸ Package manager: Use your system's package manager to update
Extension installed but not showing in VSCode â–ŧ

Try these steps:

  1. 1. Completely quit and restart VSCode (not just reload window)
  2. 2. Check if the extension is enabled: Extensions panel → Installed → Enable
  3. 3. Check the Output panel (View → Output) for any error messages
  4. 4. Try reinstalling: Uninstall the extension and run the installer again
Cannot download from GitHub releases â–ŧ

If you're behind a corporate firewall or proxy:

  1. 1. Download the .vsix file manually from GitHub Releases
  2. 2. Follow the Manual Installation instructions
  3. 3. Or configure your proxy settings and try again
Permission denied errors during installation â–ŧ

This usually happens on Linux/Mac. Try:

  • â€ĸ Make sure you have write permissions to VSCode extensions directory
  • â€ĸ Don't use sudo with the installer (it should run as your user)
  • â€ĸ Check file permissions: ls -la ~/.vscode/extensions/
  • â€ĸ If needed, fix permissions: chmod -R u+w ~/.vscode/extensions/
Still having issues?

Check our GitHub Issues or create a new issue with details about your problem. Include your OS, VSCode version, and any error messages you're seeing.