JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 32
  • Score
    100M100P100Q58591F
  • License MIT

CLI for t-req - scaffold, execute, and serve HTTP request projects

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@t-req/app) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @t-req/app

    CLI for t-req - scaffold, execute, and serve HTTP request projects.

    Installation

    npm install -g @t-req/app
# or
bun add -g @t-req/app

    Commands

    treq init - Create a new project

    treq init my-project

    This will prompt you to select:

    • Runtime: bun (recommended) or node
    • Package manager: bun, npm, pnpm, or yarn

    Skip prompts with defaults:

    treq init my-project --yes

    Uses defaults: bun runtime, bun package manager.

    Generated project structure

    my-project/
├── treq.jsonc            # Project configuration (JSONC-first)
├── .treq/                # Local state (optional, e.g. cookie jar)
├── collection/
│   ├── auth/
│   │   └── login.http    # Example POST request
│   └── users/
│       └── get.http      # Example GET request
├── run.ts                # Example script using createClient
├── package.json
└── .gitignore

    treq run - Execute HTTP requests

    Execute .http files directly from the command line:

    # Execute the first request in a file
treq run collection/auth/login.http

# Use a config profile
treq run collection/auth/login.http --profile dev

# Execute a specific request by name
treq run collection/users.http --name "Get User"

# Execute a specific request by index
treq run collection/users.http --index 2

# Pass variables
treq run collection/auth/login.http --var email=test@example.com --var password=secret

# Legacy environment module (kept for compatibility)
# Loads environments/<env>.ts or environments/<env>.js from the workspace
treq run collection/auth/login.http --env dev

# Set timeout (in milliseconds)
treq run collection/auth/login.http --timeout 30000

# Verbose output (show headers)
treq run collection/auth/login.http --verbose

    Options

    Option Description
    --name, -n Select request by @name directive
    --index, -i Select request by index (0-based)
    --profile, -p Config profile to use
    --env, -e Legacy environment module to load (environments/<env>.ts or environments/<env>.js)
    --var Set variable (can be used multiple times)
    --timeout, -t Request timeout in milliseconds
    --workspace, -w Workspace root directory
    --verbose, -v Show response headers

    treq serve - Start HTTP server

    Start an HTTP server that exposes the t-req API, enabling any programming language to execute .http files:

    # Start server on default port (4096)
treq serve

# Custom port
treq serve --port 8080

# Bind to all interfaces (for remote access)
treq serve --host 0.0.0.0 --token your-secret-token

# Enable CORS for specific origins
treq serve --cors "http://localhost:3000,http://localhost:5173"

# stdio mode (JSON-RPC over stdin/stdout)
treq serve --stdio

    Options

    Option Description
    --port, -p Port to listen on (default: 4096)
    --host, -H Host to bind to (default: 127.0.0.1)
    --token Bearer token for authentication
    --cors Allowed CORS origins (comma-separated)
    --workspace, -w Workspace root directory
    --max-body-size Max response body size in bytes (default: 10MB)
    --max-sessions Max concurrent sessions (default: 100)
    --stdio Use JSON-RPC over stdin/stdout instead of HTTP

    API Endpoints

    Method Path Description
    GET /health Server health and version info
    GET /config Resolved config summary (supports ?profile= and ?path=)
    POST /parse Parse .http file content
    POST /execute Execute HTTP request
    POST /session Create new session
    GET /session/:id Get session state
    PUT /session/:id/variables Update session variables
    DELETE /session/:id Delete session
    POST /flows Create a flow (Observer Mode grouping)
    POST /flows/:flowId/finish Finish a flow (best-effort; server TTL will also clean up)
    GET /flows/:flowId/executions/:reqExecId Fetch stored execution detail (Observer Mode)
    GET /workspace/files List .http files in workspace
    GET /workspace/requests?path=... List requests within a .http file
    GET /event?sessionId=... SSE event stream filtered by session
    GET /event?flowId=... SSE event stream filtered by flow
    GET /doc OpenAPI documentation

    When --token auth is enabled, /event requires either sessionId or flowId to prevent cross-session leakage.

    Example: Python Client

    import requests

# Execute a request
response = requests.post("http://localhost:4096/execute", json={
    "content": "GET https://api.example.com/users",
    "variables": {"token": "abc123"}
})
print(response.json())

    Example: Go Client

    resp, _ := http.Post("http://localhost:4096/execute", "application/json",
    strings.NewReader(`{"content": "GET https://api.example.com/users"}`))

    See examples/app/ for complete client examples in Python, Go, and TypeScript.

    Help

    treq --help
treq init --help
treq run --help
treq serve --help

    Protocol Version

    The server uses protocol version 1.0.

    /health is intentionally lean and only returns a basic status and server version:

    {
  "healthy": true,
  "version": "0.1.0"
}

    Security

    • Localhost by default: Server binds to 127.0.0.1 unless --host is specified
    • Token authentication: Use --token flag for bearer auth (required for remote access)
    • Path scoping: All file paths are relative to workspace root; absolute paths and .. traversal are rejected
    • CORS disabled by default: Use --cors to enable specific origins

    License

    MIT