vexp-sdk
v0.1.1
Published
TypeScript client for the self-hosted vexp code-intelligence gateway
Readme
vexp-sdk (TypeScript)
Thin, typed client for the vexp SDK — a self-hosted, machine-to-machine code-intelligence engine. It gives your agents, PR bots, and pipelines type-accurate context and cross-repo blast-radius over hundreds of repositories, on your own infrastructure. Your code never leaves your network.
This package is only the client. It talks to a vexp gateway you run yourself (see the docs); it needs the gateway's URL and a bearer token.
Install
npm install vexp-sdkQuickstart
import { VexpClient } from 'vexp-sdk'
const vx = new VexpClient('https://vexp.your-company.internal', {
token: process.env.VEXP_TOKEN,
})
// Context + impact for a task
const res = await vx.runPipeline('why does checkout fail', { repos: ['payments-gateway'] })
for (const p of res.pivots) {
console.log(p.repo, p.file_path, p.score)
}
// Cross-repo blast-radius of a symbol
await vx.impactGraph('payments.Checkout.createSession')
// Drive a re-index after a deploy
await vx.indexIncremental({ repo: 'payments-gateway', mode: 'incremental' })API
new VexpClient(baseUrl: string, opts?: { token?: string; timeoutMs?: number })
health(): Promise<{ status: string; shards: number }>
runPipeline(task: string, params?): Promise<PipelineResult> // context + impact + memory
contextCapsule(query: string, params?): Promise<unknown> // retrieval only
impactGraph(symbolFqn: string, params?): Promise<unknown> // cross-repo blast-radius
indexIncremental(opts?: { repo?: string; files?: string[]; mode?: 'incremental' | 'full' })
indexStatus(): Promise<unknown>
call<T>(tool: string, params?): Promise<T> // generic tool callPipelineResult carries pivots: Pivot[] (ranked code locations) and an optional
compressed output. Errors throw VexpError.
Requirements
- A running vexp gateway (self-hosted) reachable at
baseUrl. - A bearer token for the gateway, and a capacity
license.jwtmounted in the gateway (issued with your plan).
Full deployment and API reference: https://vexp.dev/docs/sdk
License
Proprietary. The client is free to install and use against a licensed gateway; the engine itself is license-gated. See https://vexp.dev/sdk.
