https://github.com/darrenburns/posting Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + GitHub Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions By size + Enterprise + Teams + Startups By industry + Healthcare + Financial services + Manufacturing By use case + CI/CD & Automation + DevOps + DevSecOps * Resources Topics + AI + DevOps + Innersource + Open Source + Security + Software Development Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} darrenburns / posting Public * * Notifications You must be signed in to change notification settings * Fork 14 * Star 955 The modern API client that lives in your terminal. License Apache-2.0 license 955 stars 14 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 1 * Pull requests 0 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights darrenburns/posting This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 444 Commits .github .github sample-collections sample-collections src/posting src/posting .gitignore .gitignore .python-version .python-version LICENSE LICENSE NOTICE NOTICE README.md README.md pyproject.toml pyproject.toml requirements-dev.lock requirements-dev.lock requirements.lock requirements.lock View all files Repository files navigation * README * Apache-2.0 license Posting. A powerful HTTP client that lives in your terminal. Posting is an HTTP client, not unlike Postman and Insomnia. As a TUI application, it can be used over SSH and enables efficient keyboard-centric workflows. Your requests are stored locally in simple YAML files, meaning they're easy to read and version control. image Some notable features include: "jump mode" navigation, environments/ variables system with autocompletion, syntax highlighting powered by tree-sitter, Vim keys, various builtin themes, a configuration system, "open in $EDITOR", and a command palette for quickly accessing functionality. Posting was built with Textual. Installation Posting can be installed via pipx: pipx install posting Python 3.11 or later is required. More installation methods (brew, etc) will be added soon. Collections Requests are stored directly on your file system as simple YAML files, suffixed with .posting.yaml - easy to read, understand, and version control! Here's what they look like: name: Create user description: Adds a new user to the system. method: POST url: https://jsonplaceholder.typicode.com/users body: content: |- { "firstName": "John", "email": "john.doe@example.com" } headers: - name: Content-Type value: application/json params: - name: sendWelcomeEmail value: 'true' To open a collection (a directory containing requests), use the --collection option: posting --collection path/to/collection This will recursively find and display requests in the sidebar. If you don't supply a directory, Posting will use the default collection directory. You can check where this is by running posting locate collection. Navigation Posting can be navigated using either mouse or keyboard. Jump mode Jump mode is the fastest way to get around. Press ctrl+o to enter jump mode. A key overlay will appear on the screen, allowing you to jump to any widget by pressing the corresponding key. url-bar-environments-short Tab navigation tab and shift+tab will move focus between widgets, and j/k/up/down will move around within a widget. Where it makes sense, up and down will move between widgets. Keyboard shortcuts Important keyboard shortcuts are displayed at the bottom of the screen. Some additional keyboard shortcuts are shown in the table below. Click here to see keybinds Action Shortcut Context Focus the URL bar ctrl+l Global Toggle collection browser ctrl+h Global sidebar Expand request section ctrl+m When request section is focused Expand response section ctrl+m When response section is focused Next directory shift+j When collection browser is focused Previous directory shift+k When collection browser is focused Undo in request body ctrl+z When request body text area is focused Redo in request body ctrl+y When request body text area is focused Copy selection to clipboard y or c When response body text area is focused Open in pager f3 When a text area is focused Open in external editor f4 When a text area is focused Tip Many parts of the UI support Vim keys for navigation. Exiting Posting TUI Press Ctrl+c to quit the TUI. Environments You can use variables in the UI using the ${VARIABLE_NAME} or $VARIABLE_NAME syntax. These variables will be substituted into outgoing requests. url-bar-environments-short .env files can be loaded using the --env option. Variables from these files can then be used in the UI. Example Imagine you're testing an API which exists in both dev and prod environments. The dev and prod environments share some common variables, but differ in many ways too. We can model this by having a single shared.env file which contains variables which are shared between environments, and then a dev.env and prod.env file which contain environment specific variables. # file: shared.env API_PATH="/api/v1" ENV_NAME="shared" # file: dev.env API_KEY="dev-api-key" ENV_NAME="dev" BASE_URL="https://${ENV_NAME}.example.com" # file: prod.env API_KEY="prod-api-key" ENV_NAME="prod" BASE_URL="https://${ENV_NAME}.example.com" When working in the dev environment, you can then load all of the shared variables and all of the development environment specific variables using the --env option: posting --env shared.env --env dev.env This will load all of the shared variables from shared.env, and then load the variables from dev.env. Since ENV_NAME appears in both files, the value from the dev.env file will be used since that was the last one specified. Note that you do not need to restart to load changes made to these files, so you can open and edit your env files in an editor of your choice alongside Posting. However, autocompletion and variable highlighting will not update until Posting is restarted. If you want to permit using environment variables that exist on the host machine (i.e. those which are not defined in any .env files), you must set the use_host_environment config option to true (or set the environment variable POSTING_USE_HOST_ENVIRONMENT=true). Environment specific config Since all Posting configuration options can also be specified as environment variables, we can also put environment specific config inside .env files. There's a dedicated "Configuration" section in this document which covers this in more detail. For example, if you wanted to use a light theme in the prod environment (as a subtle reminder that you're in production!), you could set the environment variable POSTING_THEME=solarized-light inside the prod.env file. Note that configuration files take precedence over environment variables, so if you set a value in both a .env file and a config.yaml, the value from the config.yaml file will be used. Command palette Some functionality in Posting doesn't warrant a dedicated keyboard shortcut (for example, switching to a specific theme), and can instead be accessed via the command palette. To open the command palette, press ctrl+p. command-palette-demo Configuration Posting can be configured using a configuration file, environment variables, and/or .env files. Configuration values are loaded in the following order of precedence (highest to lowest): 1. Configuration file 2. Environment variables 3. .env files The range of available configuration will be greatly expanded in the future. Configuration file You can write configuration for Posting using YAML. The location of the config file can be checked using the command posting locate config. Here's an example configuration file: theme: galaxy layout: horizontal response: prettify_json: false heading: visible: true show_host: false Environment variables All configuration values can also be set as environment variables. Simply prefix the name of the config with POSTING_ and set it as an environment variable. For nested configuration values, use __ as the delimiter. So to set heading.visible to false, you can set the environment variable POSTING_HEADING__VISIBLE=false. For example, to set the theme to galaxy, you can set the environment variable POSTING_THEME=galaxy. dotenv (.env) files Posting also supports .env (dotenv) files, which are useful if you want to keep your configuration in a file rather than in your shell's environment variables. You can tell Posting to use a .env file using the --env-file option. Here's an example .env file: POSTING_THEME="cobalt" POSTING_LAYOUT="vertical" POSTING_HEADING__VISIBLE="false" Available configuration options Config Key (Env Var) Values (Default) Description "posting", "galaxy", "monokai", "solarized-light", "nautilus", Sets the theme of theme (POSTING_THEME) "nebula", the application. "alpine", "cobalt", "twilight", "hacker" (Default: "posting") "vertical", Sets the layout layout (POSTING_LAYOUT) "horizontal" of the (Default: application. "horizontal") Allow/deny using environment variables from the host machine in requests via use_host_environment true, false $env: syntax. (POSTING_USE_HOST_ENVIRONMENT) (Default: false) When disabled, only variables defined explicitly in .env files will be available for use. "none", "basic", Controls the animation (POSTING_ANIMATION) "full" (Default: animation level. "none") response.prettify_json true, false If enabled, JSON (POSTING_RESPONSE__PRETTIFY_JSON) (Default: true) responses will be pretty-formatted. heading.visible true, false Show/hide the app (POSTING_HEADING__VISIBLE) (Default: true) header. heading.show_host true, false Show/hide the (POSTING_HEADING__SHOW_HOST) (Default: true) hostname in the app header. Show/hide the url_bar.show_value_preview true, false variable value (POSTING_URL_BAR__SHOW_VALUE_PREVIEW) (Default: true) preview below the URL bar. Importing OpenAPI Specifications Note: this feature is highly experimental. Posting can convert OpenAPI 3.x specs into collections. To import an OpenAPI Specification, use the posting import path/to/ openapi.yaml command. You can optionally supply an output directory. If no output directory is supplied, the default collection directory will be used. Posting will attempt to build a file structure in the collection that aligns with the URL structure of the imported API. About The modern API client that lives in your terminal. Topics python cli ssh http automation terminal rest rest-api textual tui developer-tools rest-client Resources Readme License Apache-2.0 license Activity Stars 955 stars Watchers 5 watching Forks 14 forks Report repository Releases 4 1.0.4 Latest Jul 10, 2024 + 3 releases Sponsor this project Sponsor Learn more about GitHub Sponsors Packages 0 No packages published Contributors 6 * @darrenburns * @tusharsadhwani * @treyhunner * @davidfokkema * @diegoulloao * @secnigma Languages * Python 97.3% * SCSS 2.7% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.