NetShift

NetShift CLI

Terminal-first API requests, response formatting, and quick examples

NetShift CLI

NetShift is a terminal-first API workflow tool for making HTTP requests directly from your shell. It focuses on fast requests, clean output, and readable response metadata so you can inspect APIs without switching tools.

Quick Start

Build the CLI from the cli package and run the binary:

npm run build
ns ping

If the CLI is installed and working, ping prints a simple health check message.

Features Overview

NetShift provides a solid set of core features to make interacting with APIs from your terminal a breeze. Explore the documentation to learn more about each feature:

  • Ping Command: Check the availability of the CLI.
  • HTTP Requests: Send requests using any HTTP method.
  • Query Parameters: Easily append dynamic query parameters.
  • Custom Headers: Send custom headers for authentication or content negotiation.
  • Response Output: View request metadata, response headers, and beautifully formatted JSON/HTML bodies.
  • Error Handling: Clear, readable error messages instead of messy stack traces.
  • Saved Requests: Save requests with --save and execute them later using run.

Project Architecture

The CLI is organized around a few small pieces to keep it easy to extend:

  • Request parsing and command wiring in src/cli/commands/request.ts
  • Request execution in src/services/request-service.ts
  • Output formatting for metadata, headers, response bodies, and errors
  • Utility helpers for URL normalization, query parameters, and header parsing

On this page