Localpost is a CLI API client for storing, and executing HTTP request collections, with support for environment variables and dynamic response handling.

• Auto Generation for Request Definition
• Cookies Handling
• Auto Login Before Requests
• Environment Variables
• Baseline testing

headers:
  Accept: application/json
  Content-Type: application/json
body:
  json:
    username: user
    password: pass
set-env-var:
  TOKEN:
    body: jwt-token

You can easily create those definitions with: lpost add-request

Now you can execute this request with lpost request POST_login or with shorthand flag lpost -r POST_login.

ℹ️ Collaboration: Commit your request definitions files to your repo to collaborate with others, or manage them locally without sharing. All the files is stored in lpost.

• Grab the latest release from GitHub Releases

  • Download the binary

    • macOS Intel (amd64)

      curl -L https://github.com/moshe5745/localpost/releases/latest/download/localpost_darwin_amd64.tar.gz -o lpost.tar.gz
      tar -xzf lpost.tar.gz

    • macOS Apple Silicon (arm64)

      curl -L https://github.com/moshe5745/localpost/releases/latest/download/localpost_darwin_arm64.tar.gz -o lpost.tar.gz
      tar -xzf lpost.tar.gz

    • Linux (amd64)

      curl -L https://github.com/moshe5745/localpost/releases/latest/download/localpost_linux_amd64.tar.gz -o lpost.tar.gz
      tar -xzf lpost.tar.gz

    • Linux (arm64)

      curl -L https://github.com/moshe5745/localpost/releases/latest/download/localpost_linux_arm64.tar.gz -o lpost.tar.gz
      tar -xzf lpost.tar.gz

    • Windows (x86_64)

      curl -L https://github.com/moshe5745/localpost/releases/latest/download/localpost_windows_x86_64.zip -o lpost.zip
      Expand-Archive -Path lpost.zip -DestinationPath .

    • Windows (ARM64)

      curl -L https://github.com/moshe5745/localpost/releases/latest/download/localpost_windows_arm64.zip -o lpost.zip
      Expand-Archive -Path lpost.zip -DestinationPath .

  • Make it executable

    chmod +x lpost

  • Move to /usr/local/bin (So it will be globally available in your machine)

    sudo mv lpost /usr/local/bin/lpost

• Enable autocompletion by adding the following to your shell config file.
  • Zsh

    # Add to ~/.zshrc
    source <(lpost completion --shell zsh)

  • Bash

    # Add to ~/.bashrc
    source <(lpost completion --shell bash)

  • Fish

    # Add to ~/.config/fish/config.fish
    source (lpost completion --shell fish | psub)

  • PowerShell

    # Download automated script(setup-completion.ps1) from this repo and run it in your machine.
    # .\setup-completion.ps1
    

• Use TAB key for completion

  ⚠️ After adding the completion line to your shell config (e.g., ~/.zshrc), run source ~/.zshrc (or equivalent) to apply it immediately, or restart your shell.

lpost add-request
# POST_login added

lpost set-env prod
# Default env is dev

lpost set-env-var BASE_URL https://example.com

lpost -r POST_login
$:
+--------+------+-------------------------+
| STATUS | TIME | BODY                    |
+--------+------+-------------------------+
| 200    | 29ms |     {                   |
|        |      |       "TOKEN": "123456" |
|        |      |     }                   |
+--------+------+-------------------------+

lpost -r POST_login -v
# Verbose for debugging
$:
-----
Status: 200 OK
Time: 18ms
URL: http://localhost:8080/login
-----
Request
  Headers:
    Content-Type: application/json
    ...
Request
  Body:

-----
Response
  Headers:
    Content-Type: [application/json]
    ...
Request
  Body:
    {"TOKEN":"123456"}

• Use lpost to store and manage variables for different environments (e.g., dev, prod).
• Let you set custom values (e.g., API endpoints, credentials) per environment.

ℹ️ Note: These environment variables are unique to localpost and stored in config.yaml—they’re separate from your shell’s environment, .env files, or other tools.

You can set variables in two ways:

• CLI:

  lpost set-env-var BASE_URL https://api.example.com

• YAML:

  ---
  set-env-var:
    TOKEN: # Var name
      body: jwt-token # from "jwt-token" param in JSON body
    Cookie:
      header: Cookie # from "Cookie" header

  Then you can use them inside your requests definitions:

url: "{BASE_URL}/login"
headers:
  Cookie: "{Cookie}"

For storing the collection env vars and current env used.

• File: config.yaml in the lpost directory.
• Format:

  env: dev # Current env used
  envs: # All envs list
    dev:
      BASE_URL: https://api.dev.com
      TOKEN: 123
    login:
      request: POST_login
      triggered_by: [400, 401, 403] #Default is [401]
    prod:
      BASE_URL: https://api.prod.com
      TOKEN: 456

  ℹ️ Note: config.yaml is created automatically on first use with a default env: dev if it doesn’t exist.

Request files are stored in the requests/ directory. Example (requests/POST_login.yaml):

url: "{BASE_URL}/login"
headers:
  Accept: application/json
  Content-Type: application/json
body:
  json:
    username: user
    password: pass
set-env-var:
  TOKEN:
    body: jwt-token

• Global Flag: Override the environment temporarily with -e or --env:

  lpost -e prod -r GET_users

• Body Types:

  • json: JSON object (e.g., {"key": "value"}).
  • form-urlencoded: Key-value pairs (e.g., key=value).
  • form-data: Fields and files (e.g., fields: {field: value}, files: {file: path}).
  • text: Plain text (e.g., example text).

1. Clone the repo:

   git clone https://github.com/moshe5745/localpost.git
   cd localpost

2. Build:

   go build -o localpost

3. Run:

   lpost add-request

Planned features to enhance localpost—contributions welcome!

• Schema Snapshot Tests: Compare response schemas against saved snapshots for regression testing (lpost test).

• OpenAPI Integration: Import OpenAPI specs to auto-generate request files (lpost import-openapi).
• Request Validation: Define expected status codes or headers in YAML to validate responses.
• Mock Server Mode: Run lpost as a mock API server using request files (lpost mock).
• Request Templates: Reuse common request parts from template files.

ℹ️ Got ideas?: Share them at github.com/moshe5745/localpost!

MIT License