Valstorm Logo
VALSTORM

Valstorm Developer CLI (valstorm-cli)

Command-line interface for Valstorm developers to authenticate via OAuth2 PKCE, pull and push object schemas as code, and manage local workspaces.

Treat your enterprise data model and custom objects like source code. valstorm-cli lets engineers initialize local workspace configurations (valstorm.json), pull remote object definitions and validation rules into git, push schema migrations, and share OAuth2 PKCE credentials seamlessly with valstorm-mcp.

Git-First Infrastructure-as-Code for Custom Objects & Fields
Browser OAuth 2.1 Authorization Code + PKCE Flow (365-Day Refresh)
Multi-Profile Environment Switching (local, dev, prod)
Shared Token Store with Valstorm MCP Server (Zero Double-Login)
Section 01 • Installation & Quickstart

1. Install Globally & Sync Workspace Schemas as Code

# 1. Install valstorm-cli globally using uv
uv tool install git+https://github.com/Valstorm-Corp/valstorm-cli

# 2. Authenticate via browser-based OAuth 2.1 + PKCE flow
valstorm login

# 3. Initialize a local Valstorm project (creates valstorm.json, object/, schemas/)
valstorm init

# 4. Pull remote object schemas and field definitions to local disk
valstorm pull

# 5. Push local schema changes and check API status
valstorm push
valstorm status
Section 02 • Architecture & Data Flow

2. How valstorm-cli Works Under the Hood

  💻 Local Git Workspace (valstorm.json)
     ├── object/        (Custom & Core Object Definitions)
     └── schemas/       (Typed Field & Lookup Stubs)
            │
            │  valstorm pull / valstorm push (HTTP/2 + PKCE Auth)
            ▼
  🔐 ~/.valstorm/auth_{env}_{profile}.json
     • Shared Zero-Config Token Store with valstorm-mcp
            │
            ▼
  ☁️ Valstorm Core API (https://api.valstorm.com/v1)
Section 03 • Engineering Capabilities

3. Core Capabilities & Technical Specifications

Schema-as-Code (pull & push)

Pull your organization’s entire object schema, picklists, and lookup relationships into version-controlled JSON/YAML definitions, review changes in PRs, and push atomically.

Passwordless OAuth 2.1 + PKCE Authentication

Uses SHA-256 code challenges and a local callback listener to issue long-lived refresh tokens without exposing client secrets on developer machines.

Multi-Environment Profiles

Maintain isolated credentials for local, staging, and production tenants in ~/.valstorm/auth_{env}_{profile}.json.

Unified MCP Credential Sharing

Logging in once via valstorm login automatically provisions the local token store read by valstorm-mcp in Claude Desktop and Cursor.

Section 04 • Dual-License Model

4. Open-Source & Commercial Licensing

Personal, Academic & Noncommercial Use

PolyForm Noncommercial License 1.0.0

Free to clone, inspect, modify, and run for personal projects, educational study, and noncommercial research under the PolyForm Noncommercial License 1.0.0.

Commercial & Enterprise Use

Valstorm Commercial License

Commercial use in business operations is included automatically with any active Valstorm BOS workspace ($25/mo in usage credits with $0/seat tax) or available via enterprise BYOC licensing.

5. Frequently Asked Questions

Where does valstorm-cli store authentication tokens?

Tokens are stored locally in ~/.valstorm/auth_{env}_{profile}.json with automatic proactive refresh handling and can be shared directly with valstorm-mcp and valstorm-client.

Explore Other Valstorm Open-Source Packages

View All 7 Tools →