impactmap

ImpactMap Node SDK

The official JavaScript/TypeScript SDK for interacting with the ImpactMap API.

Features

• Simple, modern API for integrating with ImpactMap
• TypeScript support out-of-the-box
• CLI for managing API keys and hubs

Installation

npm install impactmap

or

yarn add impactmap

Basic Usage

import { ImpactMap } from 'impactmap';

const client = new ImpactMap({ apiKey: 'YOUR_API_KEY' });

// Example: List projects
const projects = await client.projects.list();
console.log(projects);

CLI Usage

The ImpactMap SDK includes a CLI for securely managing API keys for different hubs (your organization's ImpactMap instance).

Setting an API Key for a Hub

You can set (or update) an API key for a hub interactively:

impactmap set-key

• You will be prompted to enter the hub URL (e.g., prefix.domain.com).
• The CLI will validate the hub by checking its health endpoint.
• If valid, you will be prompted to enter the API key.
• The key is securely stored for use with that hub.

You can also provide the hub and API key directly:

impactmap set-key prefix.domain.com YOUR_API_KEY

The CLI ensures the hub is valid before saving the key.

Listing Available Commands

impactmap --help

Contributing

Contributions are welcome! Please open issues and pull requests on GitHub.

License

MIT