Cloud ALM Link for VS Code
Cloud ALM Link integrates SAP Cloud ALM with Visual Studio Code to support the modern development lifecycle for all SAP technologies and different development approaches, especially leveraging AI.
This extension is the VS Code counterpart to Cloud ALM Link for ADT. While the ADT version helps developers understand code history, access documentation, and manage deployment, Cloud ALM Link for VS Code focuses on bridging Cloud ALM content with AI-assisted development workflows.
Prerequisites
- Visual Studio Code 1.95.0 or newer
- Access to SAP Cloud ALM
- An OAuth2 service key with the following scopes:
$XSMASTERAPPNAME.calm-api.projects.read$XSMASTERAPPNAME.calm-api.documents.read$XSMASTERAPPNAME.calm-api.features.read$XSMASTERAPPNAME.calm-api.lib.read
For instructions on creating a service key, see Enabling SAP Cloud ALM APIs.
Installation
- Open VS Code and go to the Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
- Search for Cloud ALM Link
- Click Install
Alternatively, install from the Visual Studio Marketplace.
Configuration
Basic Settings
Open VS Code Settings (Ctrl+, / Cmd+,) and search for Cloud ALM Link:
- Tenant — Your Cloud ALM tenant name (e.g.,
mycompany)
- Region — Your Cloud ALM region (e.g.,
eu10, us10)
These are required for code pattern detection (clickable Cloud ALM IDs).
API Credentials
To browse projects, search, and save locally, you also need to set OAuth2 credentials:
- Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
- Run Cloud ALM Link: Set Credentials
- Enter your client ID and client secret from the service key
Credentials are stored securely in VS Code's SecretStorage — they do not appear in settings files.
Project Filter
Optionally set cloudAlmLink.projectFilter to a comma-separated list of project UUIDs to limit which projects appear in the explorer.
Features
Pattern Detection in Source Code
The extension detects Cloud ALM IDs in your source code and makes them clickable:
- Features: IDs matching
6-XXXXX (e.g., 6-1234)
- Tasks/Requirements: IDs matching
3-XXXXX (e.g., 3-144444)
Hover over a detected ID to see a tooltip with a link to open the item in Cloud ALM. You can also right-click and select Navigate to Cloud ALM Item.
Cloud ALM Explorer
Browse your Cloud ALM data directly in the VS Code sidebar:
- Run Cloud ALM Link: Connect to Cloud ALM
- A Cloud ALM section appears in the Explorer sidebar
- Expand projects to see Documents and Features
- A top-level Developments (Library) node lists cross-project developments
- Click any item to open it read-only in the editor
Use the toolbar icons to refresh or disconnect.
Search Commands
Search across documents, features, or developments by keyword using the Command Palette.
Save Locally
Save Cloud ALM items to a .calm-docs/ folder in your workspace for offline access or to provide context to AI tools. Available via context menu in the explorer or as standalone commands.
GitHub Copilot Chat Integration
When GitHub Copilot Chat is available, the extension registers tools you can reference in chat:
| Tool Reference |
Description |
#calmSearch |
Search across all Cloud ALM item types |
#calmSearchDocuments |
Search for documents by keyword |
#calmSearchFeatures |
Search for features by keyword |
#calmSearchDevs |
Search for developments by keyword |
#calmGetDocument |
Fetch the full content of a document |
#calmGetFeature |
Get feature details including description |
#calmGetDev |
Get development details |
#calmListProjects |
List all available projects |
#calmListDocuments |
List all documents in a project |
Commands
| Command |
Description |
Cloud ALM Link: Connect to Cloud ALM |
Authenticate and show the explorer |
Cloud ALM Link: Disconnect |
Clear the session and hide the explorer |
Cloud ALM Link: Refresh Explorer |
Reload projects and items |
Cloud ALM Link: Set Credentials |
Store OAuth2 client ID and secret |
Cloud ALM Link: Clear Credentials |
Remove stored credentials |
Cloud ALM Link: Search for Document |
Search and open documents by keyword |
Cloud ALM Link: Search for Feature |
Search and open features by keyword |
Cloud ALM Link: Search for Development |
Search and open developments by keyword |
Cloud ALM Link: Save Document Locally |
Save a single document to .calm-docs/ |
Cloud ALM Link: Save All Project Documents Locally |
Save all documents in a project |
Cloud ALM Link: Save Feature Locally |
Save a single feature |
Cloud ALM Link: Save All Project Features Locally |
Save all features in a project |
Cloud ALM Link: Save Development Locally |
Save a single development |
Cloud ALM Link: Save All Developments Locally |
Save all developments |
Settings
| Setting |
Description |
Default |
cloudAlmLink.tenant |
Cloud ALM tenant name |
(empty) |
cloudAlmLink.region |
Cloud ALM region |
eu10 |
cloudAlmLink.enableHighlighting |
Enable visual highlighting of detected patterns |
true |
cloudAlmLink.highlightStyle |
Highlight style: underline, background, or border |
underline |
cloudAlmLink.projectFilter |
Comma-separated project UUIDs to show (empty = all) |
(empty) |
cloudAlmLink.tokenUrl |
Custom OAuth2 token URL (empty = auto-derived from tenant/region) |
(empty) |
License
This project is licensed under the Apache License 2.0.
Copyright (c) Consetto GmbH.
