contextvm-sdk 0.1.0

Rust SDK for the ContextVM protocol — MCP over Nostr
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

---
title: Installation
description: How to install and get started with CVMI (ContextVM Interface).
---

# Installation

CVMI is distributed as an NPM package and can be run directly using `npx` without requiring a global installation.

## Prerequisites

- [Node.js](https://nodejs.org/) 18 or higher
- A package manager (npm, yarn, pnpm, or bun)

## Installing via npx (Recommended)

The easiest way to use CVMI is with `npx`, which downloads and runs the latest version on demand:

```bash
# Install ContextVM skills interactively
npx cvmi add

# Install a specific skill
npx cvmi add --skill overview
```

Using `npx` ensures you always have the latest version without managing global installations.

## Quick Start Examples

### Install Skills

Browse and install skills interactively:

```bash
npx cvmi add
```

Install a specific skill directly:

```bash
npx cvmi add --skill overview
npx cvmi add --skill typescript-sdk
npx cvmi add --skill server-dev
```

### Run a Gateway

Expose an MCP server to the Nostr network:

```bash
# Expose a local filesystem server
npx cvmi serve -- npx -y @modelcontextprotocol/server-filesystem /tmp

# Or with a remote HTTP MCP server
npx cvmi serve
```

### Use a Remote Server

Connect to a Nostr-based MCP server:

```bash
npx cvmi use npub1q...
```

## Verifying Installation

To verify CVMI is working correctly, try running the help command:

```bash
npx cvmi --help
```

You should see a list of available commands and options.

### Check Installed Skills

List all installed skills:

```bash
npx cvmi list
```

This will show you which skills are currently available in your environment.

## Global Installation (Optional)

If you prefer, you can install CVMI globally:

```bash
# Using npm
npm install -g cvmi

# Using yarn
yarn global add cvmi

# Using pnpm
pnpm add -g cvmi
```

After global installation, you can use `cvmi` directly without `npx`:

```bash
cvmi add
cvmi serve -- npx -y @modelcontextprotocol/server-filesystem /tmp
```

## Next Steps

Now that you have CVMI installed, explore:

- [Commands Reference](/cvmi/commands) - Learn about all available commands
- [Configuration](/cvmi/configuration) - Set up your environment and preferences