[ { "path": ".editorconfig", "content": "# https://editorconfig.org\nroot = true\n\n[*]\nindent_style = space\nindent_size = 4\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.yml]\nindent_size = 2\n\n[Makefile]\nindent_style = tab\nindent_size = 8\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Report a possible bug in HTTPie\ntitle: ''\nlabels: \"new, bug\"\nassignees: ''\n\n---\n\n## Checklist\n\n- [ ] I've searched for similar issues.\n- [ ] I'm using the latest version of HTTPie.\n\n---\n\n## Minimal reproduction code and steps\n\n1.\n2.\n3.\n\n## Current result\n\n…\n\n## Expected result\n\n…\n\n---\n\n## Debug output\n\nPlease re-run the command with `--debug`, then copy the entire command & output and paste both below:\n\n```bash\n$ http --debug \n\n```\n\n## Additional information, screenshots, or code examples\n\n…\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an enhancement for HTTPie\ntitle: ''\nlabels: \"new, enhancement\"\nassignees: ''\n\n---\n\n## Checklist\n\n- [ ] I've searched for similar feature requests.\n\n---\n\n## Enhancement request\n\n…\n\n---\n\n## Problem it solves\n\nE.g. “I'm always frustrated when […]”, “I’m trying to do […] so that […]”.\n\n---\n\n## Additional information, screenshots, or code examples\n\n…\n" }, { "path": ".github/ISSUE_TEMPLATE/other.md", "content": "---\nname: Other\nabout: Anything else that isn't a feature or a bug\ntitle: ''\nlabels: \"new\"\nassignees: ''\n\n---\n\nIf you have a general question, please consider asking on Discord: https://httpie.io/chat\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n # GitHub Actions\n - package-ecosystem: github-actions\n directory: /\n schedule:\n interval: daily\n assignees:\n - BoboTiG\n" }, { "path": ".github/workflows/benchmark.yml", "content": "name: Benchmark\n\non:\n pull_request:\n types: [ labeled ]\n\npermissions:\n issues: write\n pull-requests: write\n\njobs:\n test:\n if: github.event.label.name == 'benchmark'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-python@v4\n with:\n python-version: \"3.9\"\n\n - id: benchmarks\n name: Run Benchmarks\n run: |\n python -m pip install pyperf>=2.3.0\n python extras/profiling/run.py --fresh --complex --min-speed=6 --file output.txt\n body=$(cat output.txt)\n body=\"${body//'%'/'%25'}\"\n body=\"${body//$'\\n'/'%0A'}\"\n body=\"${body//$'\\r'/'%0D'}\"\n echo \"::set-output name=body::$body\"\n\n - name: Find Comment\n uses: peter-evans/find-comment@v2\n id: fc\n with:\n issue-number: ${{ github.event.pull_request.number }}\n comment-author: 'github-actions[bot]'\n body-includes: '# Benchmarks'\n\n - name: Create or update comment\n uses: peter-evans/create-or-update-comment@v2\n with:\n comment-id: ${{ steps.fc.outputs.comment-id }}\n issue-number: ${{ github.event.pull_request.number }}\n body: |\n # Benchmarks\n ${{ steps.benchmarks.outputs.body }}\n edit-mode: replace\n\n - uses: actions-ecosystem/action-remove-labels@v1\n with:\n labels: benchmark\n" }, { "path": ".github/workflows/code-style.yml", "content": "name: Code Style Check\n\non:\n pull_request:\n paths:\n - .github/workflows/code-style.yml\n - extras/*.py\n - httpie/**/*.py\n - setup.py\n - tests/**/*.py\n\njobs:\n code-style:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-python@v4\n with:\n python-version: 3.9\n - run: make venv\n - run: make codestyle\n" }, { "path": ".github/workflows/content.yml", "content": "name: Update Generated Content\non:\n push:\n branches:\n - master\njobs:\n update-content:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-python@v4\n with:\n python-version: 3.9\n - run: make content\n - name: Create Pull Request\n id: cpr\n uses: peter-evans/create-pull-request@v4\n with:\n commit-message: \"[automated] Update generated content\"\n title: \"[automated] Update generated content\"\n delete-branch: true\n token: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/coverage.yml", "content": "name: Coverage\n\non:\n pull_request:\n paths:\n - .github/workflows/coverage.yml\n - httpie/**/*.py\n - setup.*\n - tests/**/*.py\n\njobs:\n coverage:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-python@v4\n with:\n python-version: \"3.10\"\n - run: make install\n - run: make test-cover\n - run: make codecov-upload\n env:\n CODECOV_TOKEN: ${{ secrets.CODECOV_REPO_TOKEN }}\n - run: make test-dist\n" }, { "path": ".github/workflows/docs-check-markdown.yml", "content": "name: Check Markdown Style\n\non:\n pull_request:\n paths:\n - \"*.md\"\n - \"**/*.md\"\n\njobs:\n doc:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - name: Setup Ruby\n uses: ruby/setup-ruby@v1\n with:\n ruby-version: 2.7\n - name: Install the linter\n run: sudo gem install mdl\n - name: Check files\n run: make doc-check\n" }, { "path": ".github/workflows/docs-deploy.yml", "content": "name: Deploy Documentation\n\non:\n push:\n branches:\n - master\n paths:\n - docs/README.md\n - docs/config.json\n release:\n types:\n - published\n - unpublished\n - deleted\njobs:\n trigger-doc-build:\n runs-on: ubuntu-latest\n steps:\n - name: Install HTTPie\n run: sudo pip install httpie\n - name: Trigger new documentation build\n run: http --ignore-stdin POST ${{ secrets.DOCS_UPDATE_VERCEL_HOOK }}\n" }, { "path": ".github/workflows/release-brew.yml", "content": "name: Release on Homebrew\n\non:\n workflow_dispatch:\n inputs:\n branch:\n description: \"The branch, tag or SHA to release from\"\n required: true\n default: \"master\"\n\njobs:\n brew-release:\n name: Release the Homebrew Package\n runs-on: macos-latest\n\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ github.event.inputs.branch }}\n\n - uses: mislav/bump-homebrew-formula-action@v2\n with:\n formula-name: httpie\n tag-name: ${{ github.events.inputs.branch }}\n env:\n COMMITTER_TOKEN: ${{ secrets.BREW_UPDATE_TOKEN }}\n" }, { "path": ".github/workflows/release-choco.yml", "content": "name: Release on Chocolatey\n\non:\n workflow_dispatch:\n inputs:\n branch:\n description: \"The branch, tag or SHA to release from\"\n required: true\n default: \"master\"\n\njobs:\n brew-release:\n name: Release the Chocolatey\n runs-on: windows-2019\n env:\n package-dir: docs\\packaging\\windows-chocolatey\n\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ github.event.inputs.branch }}\n\n # Chocolatey comes already installed on the Windows GHA image\n - name: Build the Choco package\n shell: cmd\n run: choco pack -v\n working-directory: ${{ env.package-dir }}\n\n - name: Check the Choco package\n run: choco info httpie -s .\n working-directory: ${{ env.package-dir }}\n\n - name: Local installation\n run: |\n choco install httpie -y -dv -s \"'.;https://community.chocolatey.org/api/v2/'\"\n working-directory: ${{ env.package-dir }}\n\n - name: Test the locally installed binaries\n run: |\n # Source: https://stackoverflow.com/a/46760714/15330941\n\n # Make `refreshenv` available right away, by defining the $env:ChocolateyInstall\n # variable and importing the Chocolatey profile module.\n $env:ChocolateyInstall = Convert-Path \"$((Get-Command choco).Path)\\..\\..\"\n Import-Module \"$env:ChocolateyInstall\\helpers\\chocolateyProfile.psm1\"\n refreshenv\n\n http --version\n https --version\n httpie --version\n choco uninstall -y httpie\n working-directory: ${{ env.package-dir }}\n\n - name: Publish on Chocolatey\n shell: bash\n env:\n CHOCO_API_KEY: ${{ secrets.CHOCO_API_KEY }}\n run: |\n choco apikey --key $CHOCO_API_KEY --source https://push.chocolatey.org/\n choco push httpie*.nupkg --source https://push.chocolatey.org/\n working-directory: ${{ env.package-dir }}\n" }, { "path": ".github/workflows/release-linux-standalone.yml", "content": "name: Release as Standalone Linux Package\n\non:\n workflow_dispatch:\n inputs:\n branch:\n description: \"The branch, tag or SHA to release from\"\n required: true\n default: \"master\"\n tag_name:\n description: \"Which release to upload the artifacts to (e.g., 3.0)\"\n required: true\n\n release:\n types: [released, prereleased]\n\n\njobs:\n binary-build-and-release:\n name: Build and Release\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ github.event.inputs.branch }}\n\n - uses: actions/setup-python@v4\n with:\n python-version: 3.9\n\n - name: Build Artifacts\n run: |\n cd extras/packaging/linux\n ./get_release_artifacts.sh\n\n - uses: actions/upload-artifact@v3\n with:\n name: http\n path: extras/packaging/linux/artifacts/dist/http\n\n - uses: actions/upload-artifact@v3\n with:\n name: httpie.deb\n path: extras/packaging/linux/artifacts/dist/*.deb\n\n - uses: actions/upload-artifact@v3\n with:\n name: httpie.rpm\n path: extras/packaging/linux/artifacts/dist/*.rpm\n\n - name: Determine the release upload upload_url\n id: release_id\n run: |\n pip install httpie\n export API_URL=\"api.github.com/repos/httpie/cli/releases/tags/${{ github.event.inputs.tag_name }}\"\n export UPLOAD_URL=`https --ignore-stdin GET $API_URL | jq -r \".upload_url\"`\n echo \"::set-output name=UPLOAD_URL::$UPLOAD_URL\"\n\n - name: Publish Debian Package\n uses: actions/upload-release-asset@v1.0.2\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ steps.release_id.outputs.UPLOAD_URL }}\n asset_path: extras/packaging/linux/artifacts/dist/httpie_${{ github.event.inputs.tag_name }}_amd64.deb\n asset_name: httpie-${{ github.event.inputs.tag_name }}.deb\n asset_content_type: binary/octet-stream\n\n - name: Publish Single Executable\n uses: actions/upload-release-asset@v1.0.2\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ steps.release_id.outputs.UPLOAD_URL }}\n asset_path: extras/packaging/linux/artifacts/dist/http\n asset_name: http\n asset_content_type: binary/octet-stream\n" }, { "path": ".github/workflows/release-pypi.yml", "content": "name: Release on PyPI\n\non:\n workflow_dispatch:\n inputs:\n branch:\n description: \"The branch, tag or SHA to release from\"\n required: true\n default: \"master\"\n\njobs:\n pypi-build-and-release:\n name: Build and Release\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ github.event.inputs.branch }}\n\n - uses: actions/setup-python@v4\n with:\n python-version: 3.9\n\n - name: Build a binary wheel and a source tarball\n run: make install && make build\n\n - name: Release on PyPI\n uses: pypa/gh-action-pypi-publish@master\n with:\n password: ${{ secrets.PYPI_TOKEN }}\n" }, { "path": ".github/workflows/release-snap.yml", "content": "name: Release on Snap\n\non:\n workflow_dispatch:\n inputs:\n branch:\n description: \"The branch, tag or SHA to release from\"\n required: true\n default: \"master\"\n\njobs:\n snap-build-and-release:\n name: Build & Release the Snap Package\n runs-on: ubuntu-latest\n\n strategy:\n # If any of the stages fail, then we'll stop the action\n # to give release manager time to investigate the underlying\n # issue.\n fail-fast: true\n matrix:\n level: [edge, beta, candidate, stable]\n\n # Set the concurrency level for this version, so\n # that we'll release one by one.\n concurrency: ${{ github.event.inputs.branch }}\n\n steps:\n - uses: actions/checkout@v3\n with:\n ref: ${{ github.event.inputs.branch }}\n\n - uses: snapcore/action-build@v1\n id: build\n\n - uses: snapcore/action-publish@v1\n env:\n SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAP_STORE_LOGIN }}\n with:\n snap: ${{ steps.build.outputs.snap }}\n release: ${{ matrix.level }}\n" }, { "path": ".github/workflows/stale.yml", "content": "name: Mark stale pull requests\n\non: workflow_dispatch\n\npermissions:\n pull-requests: write\n\njobs:\n stale:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/stale@v8\n with:\n close-pr-message: 'Thanks for the pull request, but since it was stale for more than a 30 days we are closing it. If you want to work back on it, feel free to re-open it or create a new one.'\n stale-pr-label: 'stale'\n\n days-before-stale: -1\n days-before-issue-stale: -1\n days-before-pr-stale: 30\n\n days-before-close: -1\n days-before-issue-close: -1\n days-before-pr-close: 0\n \n operations-per-run: 300\n" }, { "path": ".github/workflows/test-package-linux-snap.yml", "content": "name: Test Snap Package (Linux)\n\n\non:\n pull_request:\n paths:\n - .github/workflows/test-package-linux-snap.yml\n - snapcraft.yaml\n workflow_dispatch:\n\njobs:\n snap:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - name: Build\n uses: snapcore/action-build@v1\n id: snapcraft\n - name: Install\n run: sudo snap install --dangerous ${{ steps.snapcraft.outputs.snap }}\n - name: Test\n run: |\n httpie.http --version\n httpie.https --version\n httpie --version\n # Auto-aliases cannot be tested when installing a snap outside the store.\n # http --version\n # https --version\n" }, { "path": ".github/workflows/test-package-mac-brew.yml", "content": "name: Test Brew Package (MacOS)\n\non:\n pull_request:\n paths:\n - .github/workflows/test-package-mac-brew.yml\n - docs/packaging/brew/httpie.rb\n workflow_dispatch:\n\njobs:\n brew:\n runs-on: macos-latest\n steps:\n - uses: actions/checkout@v3\n - name: Setup brew\n run: |\n brew developer on\n brew update\n - name: Build and test the formula\n run: make brew-test\n" }, { "path": ".github/workflows/tests.yml", "content": "name: Tests\nconcurrency:\n group: ${{ github.head_ref || github.run_id }}\n cancel-in-progress: true\n\non:\n push:\n branches:\n - master\n paths:\n - .github/workflows/tests.yml\n - httpie/**/*.py\n - setup.*\n - tests/**/*.py\n pull_request:\n paths:\n - .github/workflows/tests.yml\n - httpie/**/*.py\n - setup.*\n - tests/**/*.py\n\njobs:\n test:\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, macos-13, windows-latest]\n python-version:\n - '3.12'\n - '3.11'\n - '3.10'\n - '3.9'\n - '3.8'\n - '3.7'\n pyopenssl: [0, 1]\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-python@v4\n with:\n python-version: ${{ matrix.python-version }}\n - name: Windows setup\n if: matrix.os == 'windows-latest'\n run: |\n python -m pip install --upgrade pip wheel\n python -m pip install --upgrade '.[dev]'\n python -m pytest --verbose ./httpie ./tests\n env:\n HTTPIE_TEST_WITH_PYOPENSSL: ${{ matrix.pyopenssl }}\n - name: Linux & Mac setup\n if: matrix.os != 'windows-latest'\n run: |\n make install\n make test\n env:\n HTTPIE_TEST_WITH_PYOPENSSL: ${{ matrix.pyopenssl }}\n" }, { "path": ".gitignore", "content": ".DS_Store\n.idea/\n*.egg-info\n.cache/\n*.pyc\nhtmlcov\n\n\n##############################################################################\n# The below is GitHub template for Python project. gitignore.\n# \n##############################################################################\n\n# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\npip-wheel-metadata/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.spec\n*.manifest\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n.python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nvenv*/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n# Packit\n/httpie.spec\n/httpie-*.rpm\n/httpie-*.tar.gz\n\n# VS Code\n.vscode/\n\n# Windows Chocolatey\n*.nupkg\n\nartifacts/\n" }, { "path": ".packit.yaml", "content": "# See the documentation for more information:\n# https://packit.dev/docs/configuration/\nspecfile_path: httpie.spec\nactions:\n # get the current Fedora Rawhide specfile:\n post-upstream-clone: \"wget https://src.fedoraproject.org/rpms/httpie/raw/rawhide/f/httpie.spec -O httpie.spec\"\n # Use this when the latest spec is not up-to-date.\n # post-upstream-clone: \"cp docs/packaging/linux-fedora/httpie.spec.txt httpie.spec\"\njobs:\n- job: propose_downstream\n trigger: release\n metadata:\n dist_git_branches:\n - rawhide\n" }, { "path": "AUTHORS.md", "content": "# HTTPie authors\n\n- [Jakub Roztocil](https://github.com/jakubroztocil)\n\n## Patches, features, ideas\n\n[Complete list of contributors on GitHub](https://github.com/httpie/cli/graphs/contributors)\n\n- [Cláudia T. Delgado](https://github.com/claudiatd)\n- [Hank Gay](https://github.com/gthank)\n- [Jake Basile](https://github.com/jakebasile)\n- [Vladimir Berkutov](https://github.com/dair-targ)\n- [Jakob Kramer](https://github.com/gandaro)\n- [Chris Faulkner](https://github.com/faulkner)\n- [Alen Mujezinovic](https://github.com/flashingpumpkin)\n- [Praful Mathur](https://github.com/tictactix)\n- [Marc Abramowitz](https://github.com/msabramo)\n- [Ismail Badawi](https://github.com/isbadawi)\n- [Laurent Bachelier](https://github.com/laurentb)\n- [Isman Firmansyah](https://github.com/iromli)\n- [Simon Olofsson](https://github.com/simono)\n- [Churkin Oleg](https://github.com/Bahus)\n- [Jökull Sólberg Auðunsson](https://github.com/jokull)\n- [Matthew M. Boedicker](https://github.com/mmb)\n- [marblar](https://github.com/marblar)\n- [Tomek Wójcik](https://github.com/tomekwojcik)\n- [Davey Shafik](https://github.com/dshafik)\n- [cido](https://github.com/cido)\n- [Justin Bonnar](https://github.com/jargonjustin)\n- [Nathan LaFreniere](https://github.com/nlf)\n- [Matthias Lehmann](https://github.com/matleh)\n- [Dennis Brakhane](https://github.com/brakhane)\n- [Matt Layman](https://github.com/mblayman)\n- [Edward Yang](https://github.com/honorabrutroll)\n- [Aleksandr Vinokurov](https://github.com/aleksandr-vin)\n- [Jeff Byrnes](https://github.com/jeffbyrnes)\n- [Denis Belavin](https://github.com/LuckyDenis)\n- [Mickaël Schoentgen](https://github.com/BoboTiG)\n- [Elena Lape](https://github.com/elenalape)\n- [Rohit Sehgal](https://github.com/r0hi7)\n- [Bartłomiej Jacak](https://github.com/bartekjacak)\n" }, { "path": "CHANGELOG.md", "content": "# Change Log\n\nThis document records all notable changes to [HTTPie](https://httpie.io).\nThis project adheres to [Semantic Versioning](https://semver.org/).\n\n## [3.2.4](https://github.com/httpie/cli/compare/3.2.3...3.2.4) (2024-11-01)\n\n- Fix default certs loading and unpin `requests`. ([#1596](https://github.com/httpie/cli/issues/1596))\n\n## [3.2.3](https://github.com/httpie/cli/compare/3.2.2...3.2.3) (2024-07-10)\n\n- Fix SSL connections by pinning the `requests` version to `2.31.0`. (#1583, #1581)\n- Make it possible to [unset](https://httpie.io/docs/cli/default-request-headers) the `User-Agent` and `Accept-Encoding` request headers. ([#1502](https://github.com/httpie/cli/issues/1502))\n\n## [3.2.2](https://github.com/httpie/cli/compare/3.2.1...3.2.2) (2023-05-19)\n\n- Fixed compatibility with urllib3 2.0.0. ([#1499](https://github.com/httpie/cli/issues/1499))\n\n## [3.2.1](https://github.com/httpie/cli/compare/3.1.0...3.2.1) (2022-05-06)\n\n- Improved support for determining auto-streaming when the `Content-Type` header includes encoding information. ([#1383](https://github.com/httpie/cli/pull/1383))\n- Fixed the display of the crash happening in the secondary process for update checks. ([#1388](https://github.com/httpie/cli/issues/1388))\n\n## [3.2.0](https://github.com/httpie/cli/compare/3.1.0...3.2.0) (2022-05-05)\n\n- Added a warning for notifying the user about the new updates. ([#1336](https://github.com/httpie/cli/pull/1336))\n- Added support for single binary executables. ([#1330](https://github.com/httpie/cli/pull/1330))\n- Added support for man pages (and auto generation of them from the parser declaration). ([#1317](https://github.com/httpie/cli/pull/1317))\n- Added `http --manual` for man pages & regular manual with pager. ([#1343](https://github.com/httpie/cli/pull/1343))\n- Added support for session persistence of repeated headers with the same name. ([#1335](https://github.com/httpie/cli/pull/1335))\n- Added support for sending `Secure` cookies to the `localhost` (and `.local` suffixed domains). ([#1308](https://github.com/httpie/cli/issues/1308))\n- Improved UI for the progress bars. ([#1324](https://github.com/httpie/cli/pull/1324))\n- Fixed redundant creation of `Content-Length` header on `OPTIONS` requests. ([#1310](https://github.com/httpie/cli/issues/1310))\n- Fixed blocking of warning thread on some use cases. ([#1349](https://github.com/httpie/cli/issues/1349))\n- Changed `httpie plugins` to the new `httpie cli` namespace as `httpie cli plugins` (`httpie plugins` continues to work as a hidden alias). ([#1320](https://github.com/httpie/cli/issues/1320))\n- Soft deprecated the `--history-print`. ([#1380](https://github.com/httpie/cli/pull/1380))\n\n## [3.1.0](https://github.com/httpie/cli/compare/3.0.2...3.1.0) (2022-03-08)\n\n- **SECURITY** Fixed the [vulnerability](https://github.com/httpie/cli/security/advisories/GHSA-9w4w-cpc8-h2fq) that caused exposure of cookies on redirects to third party hosts. ([#1312](https://github.com/httpie/cli/pull/1312))\n- Fixed escaping of integer indexes with multiple backslashes in the nested JSON builder. ([#1285](https://github.com/httpie/cli/issues/1285))\n- Fixed displaying of status code without a status message on non-`auto` themes. ([#1300](https://github.com/httpie/cli/issues/1300))\n- Fixed redundant issuance of stdin detection warnings on some rare cases due to underlying implementation. ([#1303](https://github.com/httpie/cli/pull/1303))\n- Fixed double `--quiet` so that it will now suppress all python level warnings. ([#1271](https://github.com/httpie/cli/issues/1271))\n- Added support for specifying certificate private key passphrases through `--cert-key-pass` and prompts. ([#946](https://github.com/httpie/cli/issues/946))\n- Added `httpie cli export-args` command for exposing the parser specification for the `http`/`https` commands. ([#1293](https://github.com/httpie/cli/pull/1293))\n- Improved regulation of top-level arrays. ([#1292](https://github.com/httpie/cli/commit/225dccb2186f14f871695b6c4e0bfbcdb2e3aa28))\n- Improved UI layout for standalone invocations. ([#1296](https://github.com/httpie/cli/pull/1296))\n\n## [3.0.2](https://github.com/httpie/cli/compare/3.0.1...3.0.2) (2022-01-24)\n\n[What’s new in HTTPie for Terminal 3.0 →](https://httpie.io/blog/httpie-3.0.0)\n\n- Fixed usage of `httpie` when there is a presence of a config with `default_options`. ([#1280](https://github.com/httpie/cli/pull/1280))\n\n## [3.0.1](https://github.com/httpie/cli/compare/3.0.0...3.0.1) (2022-01-23)\n\n[What’s new in HTTPie for Terminal 3.0 →](https://httpie.io/blog/httpie-3.0.0)\n\n- Changed the value shown as time elapsed from time-to-read-headers to total exchange time. ([#1277](https://github.com/httpie/cli/issues/1277))\n\n## [3.0.0](https://github.com/httpie/cli/compare/2.6.0...3.0.0) (2022-01-21)\n\n[What’s new in HTTPie for Terminal 3.0 →](https://httpie.io/blog/httpie-3.0.0)\n\n- Dropped support for Python 3.6. ([#1177](https://github.com/httpie/cli/issues/1177))\n- Improved startup time by 40%. ([#1211](https://github.com/httpie/cli/pull/1211))\n- Added support for nested JSON syntax. ([#1169](https://github.com/httpie/cli/issues/1169))\n- Added `httpie plugins` interface for plugin management. ([#566](https://github.com/httpie/cli/issues/566))\n- Added support for Bearer authentication via `--auth-type=bearer` ([#1215](https://github.com/httpie/cli/issues/1215)).\n- Added support for quick conversions of pasted URLs into HTTPie calls by adding a space after the protocol name (`$ https ://pie.dev` → `https://pie.dev`). ([#1195](https://github.com/httpie/cli/issues/1195))\n- Added support for _sending_ multiple HTTP header lines with the same name. ([#130](https://github.com/httpie/cli/issues/130))\n- Added support for _receiving_ multiple HTTP headers lines with the same name. ([#1207](https://github.com/httpie/cli/issues/1207))\n- Added support for basic JSON types on `--form`/`--multipart` when using JSON only operators (`:=`/`:=@`). ([#1212](https://github.com/httpie/cli/issues/1212))\n- Added support for automatically enabling `--stream` when `Content-Type` is `text/event-stream`. ([#376](https://github.com/httpie/cli/issues/376))\n- Added support for displaying the total elapsed time through `--meta`/`-vv` or `--print=m`. ([#243](https://github.com/httpie/cli/issues/243))\n- Added new `pie-dark`/`pie-light` (and `pie`) styles that match with [HTTPie for Web and Desktop](https://httpie.io/product). ([#1237](https://github.com/httpie/cli/issues/1237))\n- Added support for better error handling on DNS failures. ([#1248](https://github.com/httpie/cli/issues/1248))\n- Added support for storing prompted passwords in the local sessions. ([#1098](https://github.com/httpie/cli/issues/1098))\n- Added warnings about the `--ignore-stdin`, when there is no incoming data from stdin. ([#1255](https://github.com/httpie/cli/issues/1255))\n- Fixed crashing due to broken plugins. ([#1204](https://github.com/httpie/cli/issues/1204))\n- Fixed auto addition of XML declaration to every formatted XML response. ([#1156](https://github.com/httpie/cli/issues/1156))\n- Fixed highlighting when `Content-Type` specifies `charset`. ([#1242](https://github.com/httpie/cli/issues/1242))\n- Fixed an unexpected crash when `--raw` is used with `--chunked`. ([#1253](https://github.com/httpie/cli/issues/1253))\n- Changed the default Windows theme from `fruity` to `auto`. ([#1266](https://github.com/httpie/cli/issues/1266))\n\n## [2.6.0](https://github.com/httpie/cli/compare/2.5.0...2.6.0) (2021-10-14)\n\n[What’s new in HTTPie for Terminal 2.6.0 →](https://httpie.io/blog/httpie-2.6.0)\n\n- Added support for formatting & coloring of JSON bodies preceded by non-JSON data (e.g., an XXSI prefix). ([#1130](https://github.com/httpie/cli/issues/1130))\n- Added charset auto-detection when `Content-Type` doesn’t include it. ([#1110](https://github.com/httpie/cli/issues/1110), [#1168](https://github.com/httpie/cli/issues/1168))\n- Added `--response-charset` to allow overriding the response encoding for terminal display purposes. ([#1168](https://github.com/httpie/cli/issues/1168))\n- Added `--response-mime` to allow overriding the response mime type for coloring and formatting for the terminal. ([#1168](https://github.com/httpie/cli/issues/1168))\n- Added the ability to silence warnings through using `-q` or `--quiet` twice (e.g. `-qq`) ([#1175](https://github.com/httpie/cli/issues/1175))\n- Added installed plugin list to `--debug` output. ([#1165](https://github.com/httpie/cli/issues/1165))\n- Fixed duplicate keys preservation in JSON data. ([#1163](https://github.com/httpie/cli/issues/1163))\n\n## [2.5.0](https://github.com/httpie/cli/compare/2.4.0...2.5.0) (2021-09-06)\n\n[What’s new in HTTPie for Terminal 2.5.0 →](https://httpie.io/blog/httpie-2.5.0)\n\n- Added `--raw` to allow specifying the raw request body without extra processing as\n an alternative to `stdin`. ([#534](https://github.com/httpie/cli/issues/534))\n- Added support for XML formatting. ([#1129](https://github.com/httpie/cli/issues/1129))\n- Added internal support for file-like object responses to improve adapter plugin support. ([#1094](https://github.com/httpie/cli/issues/1094))\n- Fixed `--continue --download` with a single byte to be downloaded left. ([#1032](https://github.com/httpie/cli/issues/1032))\n- Fixed `--verbose` HTTP 307 redirects with streamed request body. ([#1088](https://github.com/httpie/cli/issues/1088))\n- Fixed handling of session files with `Cookie:` followed by other headers. ([#1126](https://github.com/httpie/cli/issues/1126))\n\n## [2.4.0](https://github.com/httpie/cli/compare/2.3.0...2.4.0) (2021-02-06)\n\n- Added support for `--session` cookie expiration based on `Set-Cookie: max-age=`. ([#1029](https://github.com/httpie/cli/issues/1029))\n- Show a `--check-status` warning with `--quiet` as well, not only when the output is redirected. ([#1026](https://github.com/httpie/cli/issues/1026))\n- Fixed upload with `--session` ([#1020](https://github.com/httpie/cli/issues/1020)).\n- Fixed a missing blank line between request and response ([#1006](https://github.com/httpie/cli/issues/1006)).\n\n## [2.3.0](https://github.com/httpie/cli/compare/2.2.0...2.3.0) (2020-10-25)\n\n- Added support for streamed uploads ([#201](https://github.com/httpie/cli/issues/201)).\n- Added support for multipart upload streaming ([#684](https://github.com/httpie/cli/issues/684)).\n- Added support for body-from-file upload streaming (`http pie.dev/post @file`).\n- Added `--chunked` to enable chunked transfer encoding ([#753](https://github.com/httpie/cli/issues/753)).\n- Added `--multipart` to allow `multipart/form-data` encoding for non-file `--form` requests as well.\n- Added support for preserving field order in multipart requests ([#903](https://github.com/httpie/cli/issues/903)).\n- Added `--boundary` to allow a custom boundary string for `multipart/form-data` requests.\n- Added support for combining cookies specified on the CLI and in a session file ([#932](https://github.com/httpie/cli/issues/932)).\n- Added out of the box SOCKS support with no extra installation ([#904](https://github.com/httpie/cli/issues/904)).\n- Added `--quiet, -q` flag to enforce silent behaviour.\n- Fixed the handling of invalid `expires` dates in `Set-Cookie` headers ([#963](https://github.com/httpie/cli/issues/963)).\n- Removed Tox testing entirely ([#943](https://github.com/httpie/cli/issues/943)).\n\n## [2.2.0](https://github.com/httpie/cli/compare/2.1.0...2.2.0) (2020-06-18)\n\n- Added support for custom content types for uploaded files ([#668](https://github.com/httpie/cli/issues/668)).\n- Added support for `$XDG_CONFIG_HOME` ([#920](https://github.com/httpie/cli/issues/920)).\n- Added support for `Set-Cookie`-triggered cookie expiration ([#853](https://github.com/httpie/cli/issues/853)).\n- Added `--format-options` to allow disabling sorting, etc. ([#128](https://github.com/httpie/cli/issues/128))\n- Added `--sorted` and `--unsorted` shortcuts for (un)setting all sorting-related `--format-options`. ([#128](https://github.com/httpie/cli/issues/128))\n- Added `--ciphers` to allow configuring OpenSSL ciphers ([#870](https://github.com/httpie/cli/issues/870)).\n- Added `netrc` support for auth plugins. Enabled for `--auth-type=basic`\n and `digest`, 3rd parties may opt in ([#718](https://github.com/httpie/cli/issues/718), [#719](https://github.com/httpie/cli/issues/719), [#852](https://github.com/httpie/cli/issues/852), [#934](https://github.com/httpie/cli/issues/934)).\n- Fixed built-in plugins-related circular imports ([#925](https://github.com/httpie/cli/issues/925)).\n\n## [2.1.0](https://github.com/httpie/cli/compare/2.0.0...2.1.0) (2020-04-18)\n\n- Added `--path-as-is` to bypass dot segment (`/../` or `/./`)\n URL squashing ([#895](https://github.com/httpie/cli/issues/895)).\n- Changed the default `Accept` header value for JSON requests from\n `application/json, */*` to `application/json, */*;q=0.5`\n to clearly indicate preference ([#488](https://github.com/httpie/cli/issues/488)).\n- Fixed `--form` file upload mixed with redirected `stdin` error handling\n ([#840](https://github.com/httpie/cli/issues/840)).\n\n## [2.0.0](https://github.com/httpie/cli/compare/1.0.3...2.0.0) (2020-01-12)\n\n- Removed Python 2.7 support ([EOL Jan 2020](https://www.python.org/doc/sunset-python-2/).\n- Added `--offline` to allow building an HTTP request and printing it but not\n actually sending it over the network.\n- Replaced the old collect-all-then-process handling of HTTP communication\n with one-by-one processing of each HTTP request or response as they become\n available. This means that you can see headers immediately,\n see what is being sent even if the request fails, etc.\n- Removed automatic config file creation to avoid concurrency issues.\n- Removed the default 30-second connection `--timeout` limit.\n- Removed Python’s default limit of 100 response headers.\n- Added `--max-headers` to allow setting the max header limit.\n- Added `--compress` to allow request body compression.\n- Added `--ignore-netrc` to allow bypassing credentials from `.netrc`.\n- Added `https` alias command with `https://` as the default scheme.\n- Added `$ALL_PROXY` documentation.\n- Added type annotations throughout the codebase.\n- Added `tests/` to the PyPi package for the convenience of\n downstream package maintainers.\n- Fixed an error when `stdin` was a closed fd.\n- Improved `--debug` output formatting.\n\n## [1.0.3](https://github.com/httpie/cli/compare/1.0.2...1.0.3) (2019-08-26)\n\n- Fixed CVE-2019-10751 — the way the output filename is generated for\n `--download` requests without `--output` resulting in a redirect has\n been changed to only consider the initial URL as the base for the generated\n filename, and not the final one. This fixes a potential security issue under\n the following scenario:\n\n 1. A `--download` request with no explicit `--output` is made (e.g.,\n `$ http -d example.org/file.txt`), instructing httpie to\n [generate the output filename](https://httpie.org/doc#downloaded-filename)\n from the `Content-Disposition` response header, or from the URL if the header\n is not provided.\n 2. The server handling the request has been modified by an attacker and\n instead of the expected response the URL returns a redirect to another\n URL, e.g., `attacker.example.org/.bash_profile`, whose response does\n not provide a `Content-Disposition` header (i.e., the base for the\n generated filename becomes `.bash_profile` instead of `file.txt`).\n 3. Your current directory doesn’t already contain `.bash_profile`\n (i.e., no unique suffix is added to the generated filename).\n 4. You don’t notice the potentially unexpected output filename\n as reported by httpie in the console output\n (e.g., `Downloading 100.00 B to \".bash_profile\"`).\n\n Reported by Raul Onitza and Giulio Comi.\n\n## [1.0.2](https://github.com/httpie/cli/compare/1.0.1...1.0.2) (2018-11-14)\n\n- Fixed tests for installation with pyOpenSSL.\n\n## [1.0.1](https://github.com/httpie/cli/compare/1.0.0...1.0.1) (2018-11-14)\n\n- Removed external URL calls from tests.\n\n## [1.0.0](https://github.com/httpie/cli/compare/0.9.9...1.0.0) (2018-11-02)\n\n- Added `--style=auto` which follows the terminal ANSI color styles.\n- Added support for selecting TLS 1.3 via `--ssl=tls1.3`\n (available once implemented in upstream libraries).\n- Added `true`/`false` as valid values for `--verify`\n (in addition to `yes`/`no`) and the boolean value is case-insensitive.\n- Changed the default `--style` from `solarized` to `auto` (on Windows it stays `fruity`).\n- Fixed default headers being incorrectly case-sensitive.\n- Removed Python 2.6 support.\n\n## [0.9.9](https://github.com/httpie/cli/compare/0.9.8...0.9.9) (2016-12-08)\n\n- Fixed README.\n\n## [0.9.8](https://github.com/httpie/cli/compare/0.9.6...0.9.8) (2016-12-08)\n\n- Extended auth plugin API.\n- Added exit status code `7` for plugin errors.\n- Added support for `curses`-less Python installations.\n- Fixed `REQUEST_ITEM` arg incorrectly being reported as required.\n- Improved `CTRL-C` interrupt handling.\n- Added the standard exit status code `130` for keyboard interrupts.\n\n## [0.9.6](https://github.com/httpie/cli/compare/0.9.4...0.9.6) (2016-08-13)\n\n- Added Python 3 as a dependency for Homebrew installations\n to ensure some of the newer HTTP features work out of the box\n for macOS users (starting with HTTPie 0.9.4.).\n- Added the ability to unset a request header with `Header:`, and send an\n empty value with `Header;`.\n- Added `--default-scheme ` to enable things like\n `$ alias https='http --default-scheme=https`.\n- Added `-I` as a shortcut for `--ignore-stdin`.\n- Added fish shell completion (located in `extras/httpie-completion.fish`\n in the GitHub repo).\n- Updated `requests` to 2.10.0 so that SOCKS support can be added via\n `pip install requests[socks]`.\n- Changed the default JSON `Accept` header from `application/json`\n to `application/json, */*`.\n- Changed the pre-processing of request HTTP headers so that any leading\n and trailing whitespace is removed.\n\n## [0.9.4](https://github.com/httpie/cli/compare/0.9.3...0.9.4) (2016-07-01)\n\n- Added `Content-Type` of files uploaded in `multipart/form-data` requests\n- Added `--ssl=` to specify the desired SSL/TLS protocol version\n to use for HTTPS requests.\n- Added JSON detection with `--json, -j` to work around incorrect\n `Content-Type`\n- Added `--all` to show intermediate responses such as redirects (with `--follow`)\n- Added `--history-print, -P WHAT` to specify formatting of intermediate responses\n- Added `--max-redirects=N` (default 30)\n- Added `-A` as short name for `--auth-type`\n- Added `-F` as short name for `--follow`\n- Removed the `implicit_content_type` config option\n (use `\"default_options\": [\"--form\"]` instead)\n- Redirected `stdout` doesn't trigger an error anymore when `--output FILE`\n is set\n- Changed the default `--style` back to `solarized` for better support\n of light and dark terminals\n- Improved `--debug` output\n- Fixed `--session` when used with `--download`\n- Fixed `--download` to trim too long filenames before saving the file\n- Fixed the handling of `Content-Type` with multiple `+subtype` parts\n- Removed the XML formatter as the implementation suffered from multiple issues\n\n## [0.9.3](https://github.com/httpie/cli/compare/0.9.2...0.9.3) (2016-01-01)\n\n- Changed the default color `--style` from `solarized` to `monokai`\n- Added basic Bash autocomplete support (need to be installed manually)\n- Added request details to connection error messages\n- Fixed `'requests.packages.urllib3' has no attribute 'disable_warnings'`\n errors that occurred in some installations\n- Fixed colors and formatting on Windows\n- Fixed `--auth` prompt on Windows\n\n## [0.9.2](https://github.com/httpie/cli/compare/0.9.1...0.9.2) (2015-02-24)\n\n- Fixed compatibility with Requests 2.5.1\n- Changed the default JSON `Content-Type` to `application/json` as UTF-8\n is the default JSON encoding\n\n## [0.9.1](https://github.com/httpie/cli/compare/0.9.0...0.9.1) (2015-02-07)\n\n- Added support for Requests transport adapter plugins\n (see [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket)\n and [httpie-http2](https://github.com/httpie/httpie-http2))\n\n## [0.9.0](https://github.com/httpie/cli/compare/0.8.0...0.9.0) (2015-01-31)\n\n- Added `--cert` and `--cert-key` parameters to specify a client side\n certificate and private key for SSL\n- Improved unicode support\n- Improved terminal color depth detection via `curses`\n- To make it easier to deal with Windows paths in request items, `\\`\n now only escapes special characters (the ones that are used as key-value\n separators by HTTPie)\n- Switched from `unittest` to `pytest`\n- Added Python `wheel` support\n- Various test suite improvements\n- Added `CONTRIBUTING`\n- Fixed `User-Agent` overwriting when used within a session\n- Fixed handling of empty passwords in URL credentials\n- Fixed multiple file uploads with the same form field name\n- Fixed `--output=/dev/null` on Linux\n- Miscellaneous bugfixes\n\n## [0.8.0](https://github.com/httpie/cli/compare/0.7.1...0.8.0) (2014-01-25)\n\n- Added `field=@file.txt` and `field:=@file.json` for embedding\n the contents of text and JSON files into request data\n- Added curl-style shorthand for localhost\n- Fixed request `Host` header value output so that it doesn't contain\n credentials, if included in the URL\n\n## [0.7.1](https://github.com/httpie/cli/compare/0.6.0...0.7.1) (2013-09-24)\n\n- Added `--ignore-stdin`\n- Added support for auth plugins\n- Improved `--help` output\n- Improved `Content-Disposition` parsing for `--download` mode\n- Update to Requests 2.0.0\n\n## [0.6.0](https://github.com/httpie/cli/compare/0.5.1...0.6.0) (2013-06-03)\n\n- XML data is now formatted\n- `--session` and `--session-read-only` now also accept paths to\n session files (eg. `http --session=/tmp/session.json example.org`)\n\n## [0.5.1](https://github.com/httpie/cli/compare/0.5.0...0.5.1) (2013-05-13)\n\n- `Content-*` and `If-*` request headers are not stored in sessions\n anymore as they are request-specific\n\n## [0.5.0](https://github.com/httpie/cli/compare/0.4.1...0.5.0) (2013-04-27)\n\n- Added a download mode via `--download`\n- Fixes miscellaneous bugs\n\n## [0.4.1](https://github.com/httpie/cli/compare/0.4.0...0.4.1) (2013-02-26)\n\n- Fixed `setup.py`\n\n## [0.4.0](https://github.com/httpie/cli/compare/0.3.0...0.4.0) (2013-02-22)\n\n- Added Python 3.3 compatibility\n- Added Requests >= v1.0.4 compatibility\n- Added support for credentials in URL\n- Added `--no-option` for every `--option` to be config-friendly\n- Mutually exclusive arguments can be specified multiple times. The\n last value is used\n\n## [0.3.0](https://github.com/httpie/cli/compare/0.2.7...0.3.0) (2012-09-21)\n\n- Allow output redirection on Windows\n- Added configuration file\n- Added persistent session support\n- Renamed `--allow-redirects` to `--follow`\n- Improved the usability of `http --help`\n- Fixed installation on Windows with Python 3\n- Fixed colorized output on Windows with Python 3\n- CRLF HTTP header field separation in the output\n- Added exit status code `2` for timed-out requests\n- Added the option to separate colorizing and formatting\n (`--pretty=all`, `--pretty=colors` and `--pretty=format`)\n `--ugly` has bee removed in favor of `--pretty=none`\n\n## [0.2.7](https://github.com/httpie/cli/compare/0.2.5...0.2.7) (2012-08-07)\n\n- Added compatibility with Requests 0.13.6\n- Added streamed terminal output. `--stream, -S` can be used to enable\n streaming also with `--pretty` and to ensure a more frequent output\n flushing\n- Added support for efficient large file downloads\n- Sort headers by name (unless `--pretty=none`)\n- Response body is fetched only when needed (e.g., not with `--headers`)\n- Improved content type matching\n- Updated Solarized color scheme\n- Windows: Added `--output FILE` to store output into a file\n (piping results in corrupted data on Windows)\n- Proper handling of binary requests and responses\n- Fixed printing of `multipart/form-data` requests\n- Renamed `--traceback` to `--debug`\n\n## [0.2.6](https://github.com/httpie/cli/compare/0.2.5...0.2.6) (2012-07-26)\n\n- The short option for `--headers` is now `-h` (`-t` has been\n removed, for usage use `--help`)\n- Form data and URL parameters can have multiple fields with the same name\n (e.g.,`http -f url a=1 a=2`)\n- Added `--check-status` to exit with an error on HTTP 3xx, 4xx and\n 5xx (3, 4, and 5, respectively)\n- If the output is piped to another program or redirected to a file,\n the default behaviour is to only print the response body\n (It can still be overwritten via the `--print` flag.)\n- Improved highlighting of HTTP headers\n- Added query string parameters (`param==value`)\n- Added support for terminal colors under Windows\n\n## [0.2.5](https://github.com/httpie/cli/compare/0.2.2...0.2.5) (2012-07-17)\n\n- Unicode characters in prettified JSON now don't get escaped for\n improved readability\n- --auth now prompts for a password if only a username provided\n- Added support for request payloads from a file path with automatic\n `Content-Type` (`http URL @/path`)\n- Fixed missing query string when displaying the request headers via\n `--verbose`\n- Fixed Content-Type for requests with no data\n\n## [0.2.2](https://github.com/httpie/cli/compare/0.2.1...0.2.2) (2012-06-24)\n\n- The `METHOD` positional argument can now be omitted (defaults to\n `GET`, or to `POST` with data)\n- Fixed --verbose --form\n- Added support for Tox\n\n## [0.2.1](https://github.com/httpie/cli/compare/0.2.0...0.2.1) (2012-06-13)\n\n- Added compatibility with `requests-0.12.1`\n- Dropped custom JSON and HTTP lexers in favor of the ones newly included\n in `pygments-1.5`\n\n## [0.2.0](https://github.com/httpie/cli/compare/0.1.6...0.2.0) (2012-04-25)\n\n- Added Python 3 support\n- Added the ability to print the HTTP request as well as the response\n (see `--print` and `--verbose`)\n- Added support for Digest authentication\n- Added file upload support\n (`http -f POST file_field_name@/path/to/file`)\n- Improved syntax highlighting for JSON\n- Added support for field name escaping\n- Many bug fixes\n\n## [0.1.6](https://github.com/httpie/cli/compare/0.1.5...0.1.6) (2012-03-04)\n\n- Fixed `setup.py`\n\n## [0.1.5](https://github.com/httpie/cli/compare/0.1.4...0.1.5) (2012-03-04)\n\n- Many improvements and bug fixes\n\n## [0.1.4](https://github.com/httpie/cli/compare/b966efa...0.1.4) (2012-02-28)\n\n- Many improvements and bug fixes\n\n## [0.1.0](https://github.com/httpie/cli/commit/b966efa) (2012-02-25)\n\n- Initial public release\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n- Using welcoming and inclusive language\n- Being respectful of differing viewpoints and experiences\n- Gracefully accepting constructive criticism\n- Focusing on what is best for the community\n- Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n- The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n- Trolling, insulting/derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at jakub@roztocil.co. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),\nversion 1.4, available at \n\nFor answers to common questions about this code of conduct, see\n\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to HTTPie\n\nBug reports and code and documentation patches are welcome. You can\nhelp this project also by using the development version of HTTPie\nand by reporting any bugs you might encounter.\n\n## 1. Reporting bugs\n\n**It's important that you provide the full command argument list\nas well as the output of the failing command.**\n\nUse the `--debug` flag and copy&paste both the command and its output\nto your bug report, e.g.:\n\n```bash\n$ http --debug \n\n```\n\n## 2. Contributing Code and Docs\n\nBefore working on a new feature or a bug, please browse [existing issues](https://github.com/httpie/cli/issues)\nto see whether it has previously been discussed.\n\nIf your change alters HTTPie’s behaviour or interface, it's a good idea to\ndiscuss it before you start working on it.\n\nIf you are fixing an issue, the first step should be to create a test case that\nreproduces the incorrect behaviour. That will also help you to build an\nunderstanding of the issue at hand.\n\n**Pull requests introducing code changes without tests\nwill generally not get merged. The same goes for PRs changing HTTPie’s\nbehaviour and not providing documentation.**\n\nConversely, PRs consisting of documentation improvements or tests\nfor existing-yet-previously-untested behavior will very likely be merged.\nTherefore, docs and tests improvements are a great candidate for your first\ncontribution.\n\nConsider also adding a [CHANGELOG](https://github.com/httpie/cli/blob/master/CHANGELOG.md) entry for your changes.\n\n### Development Environment\n\n#### Getting the code\n\nGo to and fork the project repository.\n\n```bash\n# Clone your fork\n$ git clone git@github.com:/httpie.git\n\n# Enter the project directory\n$ cd httpie\n\n# Create a branch for your changes\n$ git checkout -b my_topical_branch\n```\n\n#### Setup\n\nThe [Makefile](https://github.com/httpie/cli/blob/master/Makefile) contains a bunch of tasks to get you started.\nYou can run `$ make` to see all the available tasks.\n\nTo get started, run the command below, which:\n\n- Creates an isolated Python virtual environment inside `./venv`\n (via the standard library [venv](https://docs.python.org/3/library/venv.html) tool);\n- installs all dependencies and also installs HTTPie\n (in editable mode so that the `http` command will point to your\n working copy).\n- and runs tests (It is the same as running `make install test`).\n\n```bash\n$ make all\n```\n\n#### Python virtual environment\n\nActivate the Python virtual environment—created via the `make install`\ntask during [setup](#setup) for your active shell session using the following command:\n\n```bash\n$ source venv/bin/activate\n```\n\n(If you use `virtualenvwrapper`, you can also use `workon httpie` to\nactivate the environment — we have created a symlink for you. It’s a bit of\na hack but it works™.)\n\nYou should now see `(httpie)` next to your shell prompt, and\nthe `http` command should point to your development copy:\n\n```bash\n(httpie) ~/Code/httpie $ which http\n/Users//Code/httpie/venv/bin/http\n(httpie) ~/Code/httpie $ http --version\n2.0.0-dev\n```\n\n(Btw, you don’t need to activate the virtual environment if you just want\nrun some of the `make` tasks. You can also invoke the development\nversion of HTTPie directly with `./venv/bin/http` without having to activate\nthe environment first. The same goes for `./venv/bin/pytest`, etc.).\n\n### Making Changes\n\nPlease make sure your changes conform to [Style Guide for Python Code](https://python.org/dev/peps/pep-0008/) (PEP8)\nand that `make pycodestyle` passes.\n\n### Testing & CI\n\nPlease add tests for any new features and bug fixes.\n\nWhen you open a Pull Request, [GitHub Actions](https://github.com/httpie/cli/actions) will automatically run HTTPie’s [test suite](https://github.com/httpie/cli/tree/master/tests) against your code, so please make sure all checks pass.\n\n#### Running tests locally\n\nHTTPie uses the [pytest](https://pytest.org/) runner.\n\n```bash\n# Run tests on the current Python interpreter with coverage.\n$ make test\n\n# Run tests with coverage\n$ make test-cover\n\n# Test PEP8 compliance\n$ make codestyle\n\n# Run extended tests — for code as well as .md files syntax, packaging, etc.\n$ make test-all\n```\n\n#### Running specific tests\n\nAfter you have activated your virtual environment (see [setup](#setup)), you\ncan run specific tests from the terminal:\n\n```bash\n# Run specific tests on the current Python\n$ python -m pytest tests/test_uploads.py\n$ python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload\n$ python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload::test_upload_ok\n```\n\nSee [Makefile](https://github.com/httpie/cli/blob/master/Makefile) for additional development utilities.\n\n#### Running benchmarks\n\nIf you are trying to work on speeding up HTTPie and want to verify your results, you\ncan run the benchmark suite. The suite will compare the last commit of your branch\nwith the master branch of your repository (or a fresh checkout of HTTPie master, through\n`--fresh`) and report the results back.\n\n```bash\n$ python extras/profiling/run.py\n```\n\nThe benchmarks can also be run on the CI. Since it is a long process, it requires manual\noversight. Ping one of the maintainers to get a `benchmark` label on your branch.\n\n#### Windows\n\nIf you are on a Windows machine and not able to run `make`,\nfollow the next steps for a basic setup. As a prerequisite, you need to have\nPython 3.7+ installed.\n\nCreate a virtual environment and activate it:\n\n```powershell\nC:\\> python -m venv --prompt httpie venv\nC:\\> venv\\Scripts\\activate\n```\n\nInstall HTTPie in editable mode with all the dependencies:\n\n```powershell\nC:\\> python -m pip install --upgrade -e .[dev]\n```\n\nYou should now see `(httpie)` next to your shell prompt, and\nthe `http` command should point to your development copy:\n\n```powershell\n# In PowerShell:\n(httpie) PS C:\\Users\\\\httpie> Get-Command http\nCommandType Name Version Source\n----------- ---- ------- ------\nApplication http.exe 0.0.0.0 C:\\Users\\\\httpie\\venv\\Scripts\\http.exe\n```\n\n```bash\n# In CMD:\n(httpie) C:\\Users\\\\httpie> where http\nC:\\Users\\\\httpie\\venv\\Scripts\\http.exe\nC:\\Users\\\\AppData\\Local\\Programs\\Python\\Python38-32\\Scripts\\http.exe\n\n(httpie) C:\\Users\\\\httpie> http --version\n2.3.0-dev\n```\n\nUse `pytest` to run tests locally with an active virtual environment:\n\n```bash\n# Run all tests\n$ python -m pytest\n```\n\n______________________________________________________________________\n\nFinally, feel free to add yourself to [AUTHORS](https://github.com/httpie/cli/blob/master/AUTHORS.md)!\n" }, { "path": "LICENSE", "content": "Copyright © 2012-2022 Jakub Roztocil \n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n 1. Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n 2. Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n 3. Neither the name of the copyright holder nor the names of its contributors\n may be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\nANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n" }, { "path": "MANIFEST.in", "content": "include LICENSE\ninclude README.md\ninclude CHANGELOG.md\ninclude AUTHORS.md\ninclude docs/README.md\n\n# \nrecursive-include tests/ *\n" }, { "path": "Makefile", "content": "###############################################################################\n# See ./CONTRIBUTING.md\n###############################################################################\n\n.PHONY: build\n\nROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))\nVERSION=$(shell grep __version__ httpie/__init__.py)\nH1=\"\\n\\n\\033[0;32m\\#\\#\\# \"\nH1END=\" \\#\\#\\# \\033[0m\\n\"\n\n\n# Only used to create our venv.\nSYSTEM_PYTHON=python3\n\nVENV_ROOT=venv\nVENV_BIN=$(VENV_ROOT)/bin\nVENV_PIP=$(VENV_BIN)/pip3\nVENV_PYTHON=$(VENV_BIN)/python\n\n\nexport PATH := $(VENV_BIN):$(PATH)\n\n\n\ndefault: list-tasks\n\n\n###############################################################################\n# Default task to get a list of tasks when `make' is run without args.\n# \n###############################################################################\n\nlist-tasks:\n\t@echo Available tasks:\n\t@echo ----------------\n\t@$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ \"^[#.]\") {print $$1}}' | sort | grep -E -v -e '^[^[:alnum:]]' -e '^$@$$'\n\t@echo\n\n\n###############################################################################\n# Installation\n###############################################################################\n\nall: uninstall-httpie install test\n\n\ninstall: venv install-reqs\n\n\ninstall-reqs:\n\t@echo $(H1)Updating package tools$(H1END)\n\t$(VENV_PIP) install --upgrade pip wheel build\n\n\t@echo $(H1)Installing dev requirements$(H1END)\n\t$(VENV_PIP) install --upgrade '.[dev]' '.[test]'\n\n\t@echo $(H1)Installing HTTPie$(H1END)\n\t$(VENV_PIP) install --upgrade --editable .\n\n\t@echo\n\n\nclean:\n\t@echo $(H1)Cleaning up$(H1END)\n\trm -rf $(VENV_ROOT)\n\t# Remove symlink for virtualenvwrapper, if we’ve created one.\n\t[ -n \"$(WORKON_HOME)\" -a -L \"$(WORKON_HOME)/httpie\" -a -f \"$(WORKON_HOME)/httpie\" ] && rm $(WORKON_HOME)/httpie || true\n\trm -rf *.egg dist build .coverage .cache .pytest_cache httpie.egg-info\n\tfind . -name '__pycache__' -delete -o -name '*.pyc' -delete\n\t@echo\n\n\nvenv:\n\t@echo $(H1)Creating a Python environment $(VENV_ROOT) $(H1END)\n\n\t$(SYSTEM_PYTHON) -m venv --prompt httpie $(VENV_ROOT)\n\n\t@echo\n\t@echo done.\n\t@echo\n\t@echo To active it manually, run:\n\t@echo\n\t@echo \" source $(VENV_BIN)/activate\"\n\t@echo\n\t@echo '(learn more: https://docs.python.org/3/library/venv.html)'\n\t@echo\n\t@if [ -n \"$(WORKON_HOME)\" ]; then \\\n\t\techo $(ROOT_DIR) > $(VENV_ROOT)/.project; \\\n\t\tif [ ! -d $(WORKON_HOME)/httpie -a ! -L $(WORKON_HOME)/httpie ]; then \\\n\t\t\tln -s $(ROOT_DIR)/$(VENV_ROOT) $(WORKON_HOME)/httpie ; \\\n\t\t\techo ''; \\\n\t\t\techo 'Since you use virtualenvwrapper, we created a symlink'; \\\n\t\t\techo 'so you can also use \"workon httpie\" to activate the venv.'; \\\n\t\t\techo ''; \\\n\t\tfi; \\\n\tfi\n\n\n###############################################################################\n# Testing\n###############################################################################\n\n\ntest:\n\t@echo $(H1)Running tests$(HEADER_EXTRA)$(H1END)\n\t$(VENV_BIN)/python -m pytest $(COV)\n\t@echo\n\n\ntest-cover: COV=--cov=httpie --cov=tests\ntest-cover: HEADER_EXTRA=' (with coverage)'\ntest-cover: test\n\n\n# test-all is meant to test everything — even this Makefile\ntest-all: clean install test test-dist codestyle\n\t@echo\n\n\ntest-dist: test-sdist test-bdist-wheel\n\t@echo\n\n\ntest-sdist: clean venv\n\t@echo $(H1)Testing sdist build an installation$(H1END)\n\t$(VENV_PIP) install build\n\t$(VENV_PYTHON) -m build --sdist\n\t$(VENV_PIP) install --force-reinstall --upgrade dist/*.gz\n\t$(VENV_BIN)/http --version\n\t@echo\n\n\ntest-bdist-wheel: clean venv\n\t@echo $(H1)Testing wheel build an installation$(H1END)\n\t$(VENV_PIP) install build\n\t$(VENV_PYTHON) -m build --wheel\n\t$(VENV_PIP) install --force-reinstall --upgrade dist/*.whl\n\t$(VENV_BIN)/http --version\n\t@echo\n\n\ntwine-check:\n\ttwine check dist/*\n\n\n# Kept for convenience, \"make codestyle\" is preferred though\npycodestyle: codestyle\n\n\ncodestyle:\n\t@echo $(H1)Running flake8$(H1END)\n\t@[ -f $(VENV_BIN)/flake8 ] || $(VENV_PIP) install --upgrade --editable '.[dev]'\n\t$(VENV_BIN)/flake8 httpie/ tests/ extras/profiling/ docs/packaging/brew/ *.py\n\t@echo\n\n\ncodecov-upload:\n\t@echo $(H1)Running codecov$(H1END)\n\t@[ -f $(VENV_BIN)/codecov ] || $(VENV_PIP) install codecov\n\t# $(VENV_BIN)/codecov --required\n\t$(VENV_BIN)/codecov\n\t@echo\n\n\ndoc-check:\n\t@echo $(H1)Running documentations checks$(H1END)\n\tmdl --git-recurse --style docs/markdownlint.rb .\n\n\n###############################################################################\n# Publishing to PyPi\n###############################################################################\n\n\nbuild:\n\trm -rf build/ dist/\n\tmv httpie/internal/__build_channel__.py httpie/internal/__build_channel__.py.original\n\techo 'BUILD_CHANNEL = \"pip\"' > httpie/internal/__build_channel__.py\n\t$(VENV_PYTHON) -m build --sdist --wheel --outdir dist/\n\tmv httpie/internal/__build_channel__.py.original httpie/internal/__build_channel__.py\n\n\npublish: test-all publish-no-test\n\n\npublish-no-test:\n\t@echo $(H1)Testing wheel build an installation$(H1END)\n\t@echo \"$(VERSION)\"\n\t@echo \"$(VERSION)\" | grep -q \"dev\" && echo '!!!Not publishing dev version!!!' && exit 1 || echo ok\n\tmake build\n\tmake twine-check\n\t$(VENV_BIN)/twine upload --repository=httpie dist/*\n\t@echo\n\n\n\n###############################################################################\n# Uninstalling\n###############################################################################\n\nuninstall-httpie:\n\t@echo $(H1)Uninstalling httpie$(H1END)\n\t- $(VENV_PIP) uninstall --yes httpie &2>/dev/null\n\n\t@echo \"Verifying…\"\n\tcd .. && ! $(VENV_PYTHON) -m httpie --version &2>/dev/null\n\n\t@echo \"Done\"\n\t@echo\n\n\n###############################################################################\n# Homebrew\n###############################################################################\n\nbrew-deps:\n\tdocs/packaging/brew/brew-deps.py\n\nbrew-test:\n\t@echo $(H1)Uninstalling httpie$(H1END)\n\t- brew uninstall httpie\n\n\t@echo $(H1)Building from source…$(H1END)\n\t- brew install --HEAD --build-from-source ./docs/packaging/brew/httpie.rb\n\n\t@echo $(H1)Verifying…$(H1END)\n\thttp --version\n\thttps --version\n\n\t@echo $(H1)Auditing…$(H1END)\n\tbrew audit --strict httpie\n\n###############################################################################\n# Generated content\n###############################################################################\n\ncontent: man installation-docs\n\nman: install\n\t@echo $(H1)Regenerate man pages$(H1END)\n\t$(VENV_PYTHON) extras/scripts/generate_man_pages.py\n\ninstallation-docs:\n\t@echo $(H1)Updating installation instructions in the docs$(H1END)\n\t$(VENV_PYTHON) docs/installation/generate.py\n" }, { "path": "README.md", "content": "

\n \n \"HTTPie\"\n \n
\n HTTPie CLI: human-friendly HTTP client for the API era\n

\n\n
\n\n[![HTTPie for Desktop](https://img.shields.io/static/v1?label=HTTPie&message=Desktop&color=4B78E6)](https://httpie.io/product)\n[![](https://img.shields.io/static/v1?label=HTTPie&message=Web%20%26%20Mobile&color=73DC8C)](https://httpie.io/app)\n[![](https://img.shields.io/static/v1?label=HTTPie&message=CLI&color=FA9BFA)](https://httpie.io/cli)\n[![Twitter](https://img.shields.io/twitter/follow/httpie?style=flat&color=%234B78E6&logoColor=%234B78E6)](https://twitter.com/httpie)\n[![Chat](https://img.shields.io/discord/725351238698270761?style=flat&label=Chat%20on%20Discord&color=%23FA9BFA)](https://httpie.io/discord)\n\n
\n\n\n
\n\n[![Docs](https://img.shields.io/badge/stable%20docs-httpie.io%2Fdocs%2Fcli-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://httpie.org/docs/cli)\n[![Latest version](https://img.shields.io/pypi/v/httpie.svg?style=flat&label=Latest&color=%234B78E6&logo=&logoColor=white)](https://pypi.python.org/pypi/httpie)\n[![Build](https://img.shields.io/github/actions/workflow/status/httpie/cli/tests.yml?branch=master&color=%23FA9BFA&label=Build)](https://github.com/httpie/cli/actions)\n[![Coverage](https://img.shields.io/codecov/c/github/httpie/cli?style=flat&label=Coverage&color=%2373DC8C)](https://codecov.io/gh/httpie/cli)\n[![PyPi downloads](https://img.shields.io/pepy/dt/httpie?style=flat&label=Downloads%20from%20PyPi%20only&color=4B78E6)](https://www.pepy.tech/projects/httpie)\n\n
\n\nHTTPie (pronounced _aitch-tee-tee-pie_) is a command-line HTTP client.\nIts goal is to make CLI interaction with web services as human-friendly as possible.\nHTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.\nThe `http` & `https` commands allow for creating and sending arbitrary HTTP requests.\nThey use simple and natural syntax and provide formatted and colorized output.\n\n
\n\n\"HTTPie\n\n\n
\n\n\n\n\n## We lost 54k GitHub stars\n\nPlease note we recently accidentally made this repo private for a moment, and GitHub deleted our community that took a decade to build. Read the full story here: https://httpie.io/blog/stardust\n\n![](docs/stardust.png)\n\n\n## Getting started\n\n- [Installation instructions →](https://httpie.io/docs#installation)\n- [Full documentation →](https://httpie.io/docs)\n\n## Features\n\n- Expressive and intuitive syntax\n- Formatted and colorized terminal output\n- Built-in JSON support\n- Forms and file uploads\n- HTTPS, proxies, and authentication\n- Arbitrary request data\n- Custom headers\n- Persistent sessions\n- `wget`-like downloads\n\n[See all features →](https://httpie.io/docs)\n\n## Examples\n\nHello World:\n\n```bash\nhttps httpie.io/hello\n```\n\nCustom [HTTP method](https://httpie.io/docs#http-method), [HTTP headers](https://httpie.io/docs#http-headers) and [JSON](https://httpie.io/docs#json) data:\n\n```bash\nhttp PUT pie.dev/put X-API-Token:123 name=John\n```\n\nBuild and print a request without sending it using [offline mode](https://httpie.io/docs/cli/offline-mode):\n\n```bash\nhttp --offline pie.dev/post hello=offline\n```\n\nUse [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comment) to post a comment on an [Issue](https://github.com/httpie/cli/issues/83) with [authentication](https://httpie.io/docs#authentication):\n\n```bash\nhttp -a USERNAME POST https://api.github.com/repos/httpie/cli/issues/83/comments body='HTTPie is awesome! :heart:'\n```\n\n[See more examples →](https://httpie.io/docs#examples)\n\n## Community & support\n\n- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links.\n- Join our [Discord server](https://httpie.io/discord) is to ask questions, discuss features, and for general API chat.\n- Tweet at [@httpie](https://twitter.com/httpie) on Twitter.\n- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag.\n- Create [GitHub Issues](https://github.com/httpie/cli/issues) for bug reports and feature requests.\n- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates.\n\n## Contributing\n\nHave a look through existing [Issues](https://github.com/httpie/cli/issues) and [Pull Requests](https://github.com/httpie/cli/pulls) that you could help with. If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/cli/issues) using one of the templates provided.\n\n[See contribution guide →](https://github.com/httpie/cli/blob/master/CONTRIBUTING.md)\n" }, { "path": "SECURITY.md", "content": "# Security policy\n\n## Reporting a vulnerability\n\nWhen you identify a vulnerability in HTTPie, please report it privately using one of the following channels:\n\n- Email to [`security@httpie.io`](mailto:security@httpie.io)\n- Report on [huntr.dev](https://huntr.dev/)\n\nIn addition to the description of the vulnerability, include the following information:\n\n- A short reproducer to verify it (it can be a small HTTP server, shell script, docker image, etc.)\n- Your deemed severity level of the vulnerability (`LOW`/`MEDIUM`/`HIGH`/`CRITICAL`)\n- [CWE](https://cwe.mitre.org/) ID, if available.\n" }, { "path": "docs/README.md", "content": "
\n\n# HTTPie documentation\n\n
\n\nHTTPie (pronounced _aitch-tee-tee-pie_) is a command-line HTTP client.\nIts goal is to make CLI interaction with web services as human-friendly as possible.\nHTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.\nThe `http` & `https` commands allow for creating and sending arbitrary HTTP requests.\nThey use simple and natural syntax and provide formatted and colorized output.\n\n
\n\n## About this document\n\nThis documentation is best viewed at [httpie.io/docs](https://httpie.org/docs).\n\nYou can select your corresponding HTTPie version as well as run examples directly from the browser using a [termible.io](https://termible.io?utm_source=httpie-readme) embedded terminal.\n\nIf you are reading this on GitHub, then this text covers the current *development* version.\nYou are invited to submit fixes and improvements to the docs by editing [this file](https://github.com/httpie/cli/blob/master/docs/README.md).\n\n
\n\n## Main features\n\n- Expressive and intuitive syntax\n- Formatted and colorized terminal output\n- Built-in JSON support\n- Forms and file uploads\n- HTTPS, proxies, and authentication\n- Arbitrary request data\n- Custom headers\n- Persistent sessions\n- Wget-like downloads\n- Linux, macOS, Windows, and FreeBSD support\n- Plugins\n- Documentation\n- Test coverage\n\n## Installation\n\n
\n\n\n\n- [Universal](#universal)\n- [macOS](#macos)\n- [Windows](#windows)\n- [Linux](#linux)\n- [FreeBSD](#freebsd)\n\n### Universal\n\n#### PyPI\n\nPlease make sure you have Python 3.7 or newer (`python --version`).\n\n```bash\n# Install httpie\n$ python -m pip install --upgrade pip wheel\n$ python -m pip install httpie\n```\n\n```bash\n# Upgrade httpie\n$ python -m pip install --upgrade pip wheel\n$ python -m pip install --upgrade httpie\n```\n\n### macOS\n\n#### Homebrew\n\nTo install [Homebrew](https://brew.sh/), see [its installation](https://docs.brew.sh/Installation).\n\n```bash\n# Install httpie\n$ brew update\n$ brew install httpie\n```\n\n```bash\n# Upgrade httpie\n$ brew update\n$ brew upgrade httpie\n```\n\n#### MacPorts\n\nTo install [MacPorts](https://www.macports.org/), see [its installation](https://www.macports.org/install.php).\n\n```bash\n# Install httpie\n$ port selfupdate\n$ port install httpie\n```\n\n```bash\n# Upgrade httpie\n$ port selfupdate\n$ port upgrade httpie\n```\n\n### Windows\n\n#### Chocolatey\n\nTo install [Chocolatey](https://chocolatey.org/), see [its installation](https://chocolatey.org/install).\n\n```bash\n# Install httpie\n$ choco install httpie\n```\n\n```bash\n# Upgrade httpie\n$ choco upgrade httpie\n```\n\n### Linux\n\n#### Debian and Ubuntu\n\nAlso works for other Debian-derived distributions like MX Linux, Linux Mint, deepin, Pop!_OS, KDE neon, Zorin OS, elementary OS, Kubuntu, Devuan, Linux Lite, Peppermint OS, Lubuntu, antiX, Xubuntu, etc.\n\n```bash\n# Install httpie\n$ curl -SsL https://packages.httpie.io/deb/KEY.gpg | sudo gpg --dearmor -o /usr/share/keyrings/httpie.gpg\n$ echo \"deb [arch=amd64 signed-by=/usr/share/keyrings/httpie.gpg] https://packages.httpie.io/deb ./\" | sudo tee /etc/apt/sources.list.d/httpie.list > /dev/null\n$ sudo apt update\n$ sudo apt install httpie\n```\n\n```bash\n# Upgrade httpie\n$ sudo apt update && sudo apt upgrade httpie\n```\n\n#### Fedora\n\n```bash\n# Install httpie\n$ dnf install httpie\n```\n\n```bash\n# Upgrade httpie\n$ dnf upgrade httpie\n```\n\n#### CentOS and RHEL\n\nAlso works for other RHEL-derived distributions like ClearOS, Oracle Linux, etc.\n\n```bash\n# Install httpie\n$ yum install epel-release\n$ yum install httpie\n```\n\n```bash\n# Upgrade httpie\n$ yum upgrade httpie\n```\n\n#### Single binary executables\n\nGet the standalone HTTPie Linux executables when you don't want to go through the full installation process.\n\n```bash\n# Install httpie\n$ https --download packages.httpie.io/binaries/linux/http-latest -o http\n$ ln -ls ./http ./https\n$ chmod +x ./http ./https\n```\n\n```bash\n# Upgrade httpie\n$ https --download packages.httpie.io/binaries/linux/http-latest -o http\n```\n\n#### Snapcraft (Linux)\n\nTo install [Snapcraft](https://snapcraft.io/), see [its installation](https://snapcraft.io/docs/installing-snapd).\n\n```bash\n# Install httpie\n$ snap install httpie\n```\n\n```bash\n# Upgrade httpie\n$ snap refresh httpie\n```\n\n#### Linuxbrew\n\nTo install [Linuxbrew](https://docs.brew.sh/Homebrew-on-Linux), see [its installation](https://docs.brew.sh/Homebrew-on-Linux#install).\n\n```bash\n# Install httpie\n$ brew update\n$ brew install httpie\n```\n\n```bash\n# Upgrade httpie\n$ brew update\n$ brew upgrade httpie\n```\n\n#### Arch Linux\n\nAlso works for other Arch-derived distributions like ArcoLinux, EndeavourOS, Artix Linux, etc.\n\n```bash\n# Install httpie\n$ pacman -Syu httpie\n```\n\n```bash\n# Upgrade httpie\n$ pacman -Syu\n```\n\n### FreeBSD\n\n#### FreshPorts\n\n```bash\n# Install httpie\n$ pkg install www/py-httpie\n```\n\n```bash\n# Upgrade httpie\n$ pkg upgrade www/py-httpie\n```\n\n\n\n
\n\n### Unstable version\n\nIf you want to try out the latest version of HTTPie that hasn't been officially released yet, you can install the development or unstable version directly from the master branch on GitHub. However, keep in mind that the development version is a work in progress and may not be as reliable as the stable version.\n\nYou can use the following command to install the development version of HTTPie on Linux, macOS, Windows, or FreeBSD operating systems. With this command, the code present in the `master` branch is downloaded and installed using `pip`.\n\n```bash\n$ python -m pip install --upgrade https://github.com/httpie/cli/archive/master.tar.gz\n```\n\nThere are other ways to install the development version of HTTPie on macOS and Linux.\n\nYou can install it using Homebrew by running the following commands:\n\n```bash\n$ brew uninstall --force httpie\n$ brew install --HEAD httpie\n```\n\nYou can install it using Snapcraft by running the following commands:\n\n```bash\n$ snap remove httpie\n$ snap install httpie --edge\n```\n\nTo verify the installation, you can compare the [version identifier on GitHub](https://github.com/httpie/cli/blob/master/httpie/__init__.py#L6) with the one available on your machine. You can check the version of HTTPie on your machine by using the command `http --version`.\n\n```bash\n$ http --version\n# 3.X.X.dev0\n```\n\nNote that on your machine, the version name will have the `.dev0` suffix.\n\n## Usage\n\nHello World:\n\n```bash\n$ https httpie.io/hello\n```\n\nSynopsis:\n\n```bash\n$ http [flags] [METHOD] URL [ITEM [ITEM]]\n```\n\nSee also `http --help` (and for systems where man pages are available, you can use `man http`).\n\n### Examples\n\nCustom [HTTP method](#http-method), [HTTP headers](#http-headers) and [JSON](#json) data:\n\n```bash\n$ http PUT pie.dev/put X-API-Token:123 name=John\n```\n\nSubmitting [forms](#forms):\n\n```bash\n$ http -f POST pie.dev/post hello=World\n```\n\nSee the request that is being sent using one of the [output options](#output-options):\n\n```bash\n$ http -v pie.dev/get\n```\n\nBuild and print a request without sending it using [offline mode](#offline-mode):\n\n```bash\n$ http --offline pie.dev/post hello=offline\n```\n\nUse [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comment) to post a comment on an [issue](https://github.com/httpie/cli/issues/83) with [authentication](#authentication):\n\n```bash\n$ http -a USERNAME POST https://api.github.com/repos/httpie/cli/issues/83/comments body='HTTPie is awesome! :heart:'\n```\n\nUpload a file using [redirected input](#redirected-input):\n\n```bash\n$ http pie.dev/post < files/data.json\n```\n\nDownload a file and save it via [redirected output](#redirected-output):\n\n```bash\n$ http pie.dev/image/png > image.png\n```\n\nDownload a file `wget` style:\n\n```bash\n$ http --download pie.dev/image/png\n```\n\nUse named [sessions](#sessions) to make certain aspects of the communication persistent between requests to the same host:\n\n```bash\n$ http --session=logged-in -a username:password pie.dev/get API-Key:123\n```\n\n```bash\n$ http --session=logged-in pie.dev/headers\n```\n\nSet a custom `Host` header to work around missing DNS records:\n\n```bash\n$ http localhost:8000 Host:example.com\n```\n\n## HTTP method\n\nThe name of the HTTP method comes right before the URL argument:\n\n```bash\n$ http DELETE pie.dev/delete\n```\n\nWhich looks similar to the actual `Request-Line` that is sent:\n\n```http\nDELETE /delete HTTP/1.1\n```\n\nIn addition to the standard methods (`GET`, `POST`, `HEAD`, `PUT`, `PATCH`, `DELETE`, etc.), you can use custom method names, for example:\n\n```bash\n$ http AHOY pie.dev/post\n```\n\nThere are no restrictions regarding which request methods can include a body. You can send an empty `POST` request:\n\n```bash\n$ http POST pie.dev/post\n```\n\nYou can also make `GET` requests containing a body:\n\n```bash\n$ http GET pie.dev/get hello=world\n```\n\n### Optional `GET` and `POST`\n\nThe `METHOD` argument is optional, and when you don’t specify it, HTTPie defaults to:\n\n- `GET` for requests without body\n- `POST` for requests with body\n\nHere we don’t specify any request data, so both commands will send the same `GET` request:\n\n```bash\n$ http GET pie.dev/get\n```\n\n```bash\n$ http pie.dev/get\n```\n\nHere, on the other hand, we do have some data, so both commands will make the same `POST` request:\n\n```bash\n$ http POST pie.dev/post hello=world\n```\n\n```bash\n$ http pie.dev/post hello=world\n```\n\n## Request URL\n\nThe only information HTTPie needs to perform a request is a URL.\n\nThe default scheme is `http://` and can be omitted from the argument:\n\n```bash\n$ http example.org\n# → http://example.org\n```\n\nHTTPie also installs an `https` executable, where the default scheme is `https://`:\n\n```bash\n$ https example.org\n# → https://example.org\n```\n\nWhen you paste a URL into the terminal, you can even keep the `://` bit in the URL argument to quickly convert the URL into an HTTPie call just by adding a space after the protocol name.\n\n```bash\n$ https ://example.org\n# → https://example.org\n```\n\n```bash\n$ http ://example.org\n# → http://example.org\n```\n\n### Querystring parameters\n\nIf you find yourself manually constructing URLs with querystring parameters on the terminal, you may appreciate the `param==value` syntax for appending URL parameters.\n\nWith that, you don’t have to worry about escaping the `&` separators for your shell. Additionally, any special characters in the parameter name or value get automatically URL-escaped (as opposed to the parameters specified in the full URL, which HTTPie doesn’t modify).\n\n```bash\n$ http https://api.github.com/search/repositories q==httpie per_page==1\n```\n\n```http\nGET /search/repositories?q=httpie&per_page=1 HTTP/1.1\n```\n\nYou can even retrieve the `value` from a file by using the `param==@file` syntax. This would also effectively strip the newlines from the end. See [file based separators](#file-based-separators) for more examples.\n\n```bash\n$ http pie.dev/get text==@files/text.txt\n```\n\n### URL shortcuts for `localhost`\n\nAdditionally, curl-like shorthand for localhost is supported.\nThis means that, for example, `:3000` would expand to `http://localhost:3000`.\nIf the port is omitted, then port 80 is assumed.\n\n```bash\n$ http :/foo\n```\n\n```http\nGET /foo HTTP/1.1\nHost: localhost\n```\n\n```bash\n$ http :3000/bar\n```\n\n```http\nGET /bar HTTP/1.1\nHost: localhost:3000\n```\n\n```bash\n$ http :\n```\n\n```http\nGET / HTTP/1.1\nHost: localhost\n```\n\n### Other default schemes\n\nWhen HTTPie is invoked as `https` then the default scheme is `https://` (`$ https example.org` will make a request to `https://example.org`).\n\nYou can also use the `--default-scheme ` option to create shortcuts for other protocols than HTTP (possibly supported via [plugins](https://pypi.org/search/?q=httpie)). Example for the [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket) plugin:\n\n```bash\n# Before\n$ http http+unix://%2Fvar%2Frun%2Fdocker.sock/info\n```\n\n```bash\n# Create an alias\n$ alias http-unix='http --default-scheme=\"http+unix\"'\n```\n\n```bash\n# Now the scheme can be omitted\n$ http-unix %2Fvar%2Frun%2Fdocker.sock/info\n```\n\n### `--path-as-is`\n\nThe standard behavior of HTTP clients is to normalize the path portion of URLs by squashing dot segments as a typical filesystem would:\n\n```bash\n$ http -v example.org/./../../etc/password\n```\n\n```http\nGET /etc/password HTTP/1.1\n```\n\nThe `--path-as-is` option allows you to disable this behavior:\n\n```bash\n$ http --path-as-is -v example.org/./../../etc/password\n```\n\n```http\nGET /../../etc/password HTTP/1.1\n```\n\n## Request items\n\nThere are a few different *request item* types that provide a convenient\nmechanism for specifying HTTP headers, JSON and form data, files,\nand URL parameters. This is a very practical way of constructing\nHTTP requests from scratch on the CLI.\n\nEach *request item* is simply a key/value pair separated with the following\ncharacters: `:` (headers), `=` (data field, e.g., JSON, form), `:=` (raw data field)\n`==` (query parameters), `@` (file upload).\n\n```bash\n$ http PUT pie.dev/put \\\n X-Date:today \\ # Header\n token==secret \\ # Query parameter\n name=John \\ # Data field\n age:=29 # Raw JSON\n```\n\n| Item Type | Description |\n|-------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| HTTP Headers `Name:Value` | Arbitrary HTTP header, e.g. `X-API-Token:123` |\n| URL parameters `name==value` | Appends the given name/value pair as a querystring parameter to the URL. The `==` separator is used. |\n| Data Fields `field=value` | Request data fields to be serialized as a JSON object (default), to be form-encoded (with `--form, -f`), or to be serialized as `multipart/form-data` (with `--multipart`) |\n| Raw JSON fields `field:=json` | Useful when sending JSON and one or more fields need to be a `Boolean`, `Number`, nested `Object`, or an `Array`, e.g., `meals:='[\"ham\",\"spam\"]'` or `pies:='[1,2,3]'` (note the quotes) |\n| File upload fields `field@/dir/file`, `field@file;type=mime` | Only available with `--form`, `-f` and `--multipart`. For example `screenshot@~/Pictures/img.png`, or `'cv@cv.txt;type=text/markdown'`. With `--form`, the presence of a file field results in a `--multipart` request |\n\nNote that the structured data fields aren’t the only way to specify request data:\n[raw request body](#raw-request-body) is a mechanism for passing arbitrary request data.\n\n### File based separators\n\nUsing file contents as values for specific fields is a very common use case, which can be achieved through adding the `@` suffix to\nthe operators above. For example, instead of using a static string as the value for some header, you can use `:@` operator\nto pass the desired value from a file.\n\n```bash\n$ http POST pie.dev/post \\\n X-Data:@files/text.txt # Read a header from a file\n token==@files/text.txt # Read a query parameter from a file\n name=@files/text.txt # Read a data field’s value from a file\n bookmarks:=@files/data.json # Embed a JSON object from a file\n```\n\n### Escaping rules\n\nYou can use `\\` to escape characters that shouldn’t be used as separators (or parts thereof). For instance, `foo\\==bar` will become a data key/value pair (`foo=` and `bar`) instead of a URL parameter.\n\nOften it is necessary to quote the values, e.g. `foo='bar baz'`.\n\nIf any of the field names or headers starts with a minus (e.g. `-fieldname`), you need to place all such items after the special token `--` to prevent confusion with `--arguments`:\n\n```bash\n$ http pie.dev/post -- -name-starting-with-dash=foo -Unusual-Header:bar\n```\n\n```http\nPOST /post HTTP/1.1\n-Unusual-Header: bar\nContent-Type: application/json\n\n{\n \"-name-starting-with-dash\": \"foo\"\n}\n```\n\n## JSON\n\nJSON is the *lingua franca* of modern web services, and it is also the **implicit content type** HTTPie uses by default.\n\nSimple example:\n\n```bash\n$ http PUT pie.dev/put name=John email=john@example.org\n```\n\n```http\nPUT / HTTP/1.1\nAccept: application/json, */*;q=0.5\nAccept-Encoding: gzip, deflate\nContent-Type: application/json\nHost: pie.dev\n\n{\n \"name\": \"John\",\n \"email\": \"john@example.org\"\n}\n```\n\n### Default behavior\n\nIf your command includes some data [request items](#request-items), they are serialized as a JSON object by default. HTTPie also automatically sets the following headers, both of which can be overwritten:\n\n| Header | Value |\n|---------------:|-------------------------------|\n| `Content-Type` | `application/json` |\n| `Accept` | `application/json, */*;q=0.5` |\n\n### Explicit JSON\n\nYou can use `--json, -j` to explicitly set `Accept` to `application/json` regardless of whether you are sending data (it’s a shortcut for setting the header via the usual header notation: `http url Accept:'application/json, */*;q=0.5'`).\nAdditionally, HTTPie will try to detect JSON responses even when the `Content-Type` is incorrectly `text/plain` or unknown.\n\n### Non-string JSON fields\n\nNon-string JSON fields use the `:=` separator, which allows you to embed arbitrary JSON data into the resulting JSON object.\nAdditionally, text and raw JSON files can also be embedded into fields using `=@` and `:=@`:\n\n```bash\n$ http PUT pie.dev/put \\\n name=John \\ # String (default)\n age:=29 \\ # Raw JSON — Number\n married:=false \\ # Raw JSON — Boolean\n hobbies:='[\"http\", \"pies\"]' \\ # Raw JSON — Array\n favorite:='{\"tool\": \"HTTPie\"}' \\ # Raw JSON — Object\n bookmarks:=@files/data.json \\ # Embed JSON file\n description=@files/text.txt # Embed text file\n```\n\n```http\nPUT /person/1 HTTP/1.1\nAccept: application/json, */*;q=0.5\nContent-Type: application/json\nHost: pie.dev\n\n{\n \"age\": 29,\n \"hobbies\": [\n \"http\",\n \"pies\"\n ],\n \"description\": \"John is a nice guy who likes pies.\",\n \"married\": false,\n \"name\": \"John\",\n \"favorite\": {\n \"tool\": \"HTTPie\"\n },\n \"bookmarks\": {\n \"HTTPie\": \"https://httpie.org\",\n }\n}\n```\n\nThe `:=`/`:=@` syntax is JSON-specific. You can switch your request to `--form` or `--multipart`,\nand string, float, and number values will continue to be serialized (as string form values).\nOther JSON types, however, are not allowed with `--form` or `--multipart`.\n\n### Nested JSON\n\nIf your use case involves sending complex JSON objects as part of the request body,\nHTTPie can help you build them right from your terminal. You still use the existing\ndata field operators (`=`/`:=`) but instead of specifying a top-level field name (like `key=value`),\nyou specify a path declaration. This tells HTTPie where and how to put the given value inside an object:\n\n```bash\nhttp pie.dev/post \\\n platform[name]=HTTPie \\\n platform[about][mission]='Make APIs simple and intuitive' \\\n platform[about][homepage]=httpie.io \\\n platform[about][homepage]=httpie.io \\\n platform[about][stars]:=54000 \\\n platform[apps][]=Terminal \\\n platform[apps][]=Desktop \\\n platform[apps][]=Web \\\n platform[apps][]=Mobile\n```\n\n```json\n{\n \"platform\": {\n \"name\": \"HTTPie\",\n \"about\": {\n \"mission\": \"Make APIs simple and intuitive\",\n \"homepage\": \"httpie.io\",\n \"stars\": 54000\n },\n \"apps\": [\n \"Terminal\",\n \"Desktop\",\n \"Web\",\n \"Mobile\"\n ]\n }\n}\n```\n\n#### Introduction\n\nLet’s start with a simple example, and build a simple search query:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n category=tools \\\n search[type]=id \\\n search[id]:=1\n```\n\nIn the example above, the `search[type]` is an instruction for creating an object called `search`, and setting the `type` field of it to the given value (`\"id\"`).\n\nAlso note that, just as the regular syntax, you can use the `:=` operator to directly pass raw JSON values (e.g., numbers in the case above).\n\n```json\n{\n \"category\": \"tools\",\n \"search\": {\n \"id\": 1,\n \"type\": \"id\"\n }\n}\n```\n\nBuilding arrays is also possible, through `[]` suffix (an append operation). This tells HTTPie to create an array in the given path (if there is not one already), and append the given value to that array.\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n category=tools \\\n search[type]=keyword \\\n search[keywords][]=APIs \\\n search[keywords][]=CLI\n```\n\n```json\n{\n \"category\": \"tools\",\n \"search\": {\n \"keywords\": [\n \"APIs\",\n \"CLI\"\n ],\n \"type\": \"keyword\"\n }\n}\n```\n\nIf you want to explicitly specify the position of elements inside an array,\nyou can simply pass the desired index as the path:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n category=tools \\\n search[type]=keyword \\\n search[keywords][1]=APIs \\\n search[keywords][0]=CLI\n```\n\n```json\n{\n \"category\": \"tools\",\n \"search\": {\n \"keywords\": [\n \"CLIs\",\n \"API\"\n ],\n \"type\": \"keyword\"\n }\n}\n```\n\nIf there are any missing indexes, HTTPie will nullify them in order to create a concrete object that can be sent:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n category=tools \\\n search[type]=platforms \\\n search[platforms][]=Terminal \\\n search[platforms][1]=Desktop \\\n search[platforms][3]=Mobile\n```\n\n```json\n{\n \"category\": \"tools\",\n \"search\": {\n \"platforms\": [\n \"Terminal\",\n \"Desktop\",\n null,\n \"Mobile\"\n ],\n \"type\": \"platforms\"\n }\n}\n```\n\nIt is also possible to embed raw JSON to a nested structure, for example:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n category=tools \\\n search[type]=platforms \\\n 'search[platforms]:=[\"Terminal\", \"Desktop\"]' \\\n search[platforms][]=Web \\\n search[platforms][]=Mobile\n```\n\n```json\n{\n \"category\": \"tools\",\n \"search\": {\n \"platforms\": [\n \"Terminal\",\n \"Desktop\",\n \"Web\",\n \"Mobile\"\n ],\n \"type\": \"platforms\"\n }\n}\n```\n\nAnd just to demonstrate all of these features together, let’s create a very deeply nested JSON object:\n\n```bash\n$ http PUT pie.dev/put \\\n shallow=value \\ # Shallow key-value pair\n object[key]=value \\ # Nested key-value pair\n array[]:=1 \\ # Array — first item\n array[1]:=2 \\ # Array — second item\n array[2]:=3 \\ # Array — append (third item)\n very[nested][json][3][httpie][power][]=Amaze # Nested object\n```\n\n#### Advanced usage\n\n##### Top level arrays\n\nIf you want to send an array instead of a regular object, you can simply\ndo that by omitting the starting key:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n []:=1 \\\n []:=2 \\\n []:=3\n```\n\n```json\n[\n 1,\n 2,\n 3\n]\n```\n\nYou can also apply the nesting to the items by referencing their index:\n\n```bash\nhttp --offline --print=B pie.dev/post \\\n [0][type]=platform [0][name]=terminal \\\n [1][type]=platform [1][name]=desktop\n```\n\n```json\n[\n {\n \"type\": \"platform\",\n \"name\": \"terminal\"\n },\n {\n \"type\": \"platform\",\n \"name\": \"desktop\"\n }\n]\n```\n\nSending scalar JSON types (a single `null`, `true`, `false`, string or number) as the top-level object is impossible using the key/value syntax. But you can still pass it via [`--raw=''`](#raw-request-body).\n\n##### Escaping behavior\n\nNested JSON syntax uses the same [escaping rules](#escaping-rules) as\nthe terminal. There are 3 special characters, and 1 special token that you can escape.\n\nIf you want to send a bracket as is, escape it with a backslash (`\\`):\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n 'foo\\[bar\\]:=1' \\\n 'baz[\\[]:=2' \\\n 'baz[\\]]:=3'\n```\n\n```json\n{\n \"baz\": {\n \"[\": 2,\n \"]\": 3\n },\n \"foo[bar]\": 1\n}\n```\n\nIf you want to send the literal backslash character (`\\`), escape it with another backslash:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n 'backslash[\\\\]:=1'\n```\n\n```json\n{\n \"backslash\": {\n \"\\\\\": 1\n }\n}\n```\n\nA regular integer in a path (e.g `[10]`) means an array index; but if you want it to be treated as\na string, you can escape the whole number by using a backslash (`\\`) prefix.\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n 'object[\\1]=stringified' \\\n 'object[\\100]=same' \\\n 'array[1]=indexified'\n```\n\n```json\n{\n \"array\": [\n null,\n \"indexified\"\n ],\n \"object\": {\n \"1\": \"stringified\",\n \"100\": \"same\"\n }\n}\n```\n\n##### Guiding syntax errors\n\nIf you make a typo or forget to close a bracket, the errors will guide you to fix it. For example:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n 'foo[bar]=OK' \\\n 'foo[baz][quux=FAIL'\n```\n\n```console\nHTTPie Syntax Error: Expecting ']'\nfoo[baz][quux\n ^\n```\n\nYou can follow to given instruction (adding a `]`) and repair your expression.\n\n##### Type safety\n\nEach container path (e.g., `x[y][z]` in `x[y][z][1]`) has a certain type, which gets defined with\nthe first usage and can’t be changed after that. If you try to do a key-based access to an array or\nan index-based access to an object, HTTPie will error out:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n 'array[]:=1' \\\n 'array[]:=2' \\\n 'array[key]:=3'\nHTTPie Type Error: Can't perform 'key' based access on 'array' which has a type of 'array' but this operation requires a type of 'object'.\narray[key]\n ^^^^^\n```\n\nType Safety does not apply to value overrides, for example:\n\n```bash\n$ http --offline --print=B pie.dev/post \\\n user[name]:=411 # Defined as an integer\n user[name]=string # Overridden with a string\n```\n\n```json\n{\n \"user\": {\n \"name\": \"string\"\n }\n}\n```\n\n### Raw JSON\n\nFor very complex JSON structures, it may be more convenient to [pass it as raw request body](#raw-request-body), for example:\n\n```bash\n$ echo -n '{\"hello\": \"world\"}' | http POST pie.dev/post\n```\n\n```bash\n$ http POST pie.dev/post < files/data.json\n```\n\n## Forms\n\nSubmitting forms is very similar to sending [JSON](#json) requests.\nOften the only difference is in adding the `--form, -f` option, which ensures that data fields are serialized as key-value tuples separated by '&', with a '=' between the key and the value. In addition `Content-Type` is set to `application/x-www-form-urlencoded; charset=utf-8`.\nIt is possible to make form data the implicit content type instead of JSON via the [config](#config) file.\n\n### Regular forms\n\n```bash\n$ http --form POST pie.dev/post name='John Smith'\n```\n\n```http\nPOST /post HTTP/1.1\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\n\nname=John+Smith\n```\n\n### File upload forms\n\nIf one or more file fields is present, the serialization and content type is `multipart/form-data`:\n\n```bash\n$ http -f POST pie.dev/post name='John Smith' cv@~/files/data.xml\n```\n\nThe request above is the same as if the following HTML form were submitted:\n\n```html\n
\n \n \n
\n```\n\nPlease note that `@` is used to simulate a file upload form field, whereas `=@` just embeds the file content as a regular text field value.\n\nWhen uploading files, their content type is inferred from the file name. You can manually override the inferred content type:\n\n```bash\n$ http -f POST pie.dev/post name='John Smith' cv@'~/files/data.bin;type=application/pdf'\n```\n\nTo perform a `multipart/form-data` request even without any files, use `--multipart` instead of `--form`:\n\n```bash\n$ http --multipart --offline example.org hello=world\n```\n\n```http\nPOST / HTTP/1.1\nContent-Length: 129\nContent-Type: multipart/form-data; boundary=c31279ab254f40aeb06df32b433cbccb\nHost: example.org\n\n--c31279ab254f40aeb06df32b433cbccb\nContent-Disposition: form-data; name=\"hello\"\n\nworld\n--c31279ab254f40aeb06df32b433cbccb--\n```\n\nFile uploads are always streamed to avoid memory issues with large files.\n\nBy default, HTTPie uses a random unique string as the multipart boundary, but you can use `--boundary` to specify a custom string instead:\n\n```bash\n$ http --form --multipart --boundary=xoxo --offline example.org hello=world\n```\n\n```http\nPOST / HTTP/1.1\nContent-Length: 129\nContent-Type: multipart/form-data; boundary=xoxo\nHost: example.org\n\n--xoxo\nContent-Disposition: form-data; name=\"hello\"\n\nworld\n--xoxo--\n```\n\nIf you specify a custom `Content-Type` header without including the boundary bit, HTTPie will add the boundary value (explicitly specified or auto-generated) to the header automatically:\n\n```bash\n$ http --form --multipart --offline example.org hello=world Content-Type:multipart/letter\n```\n\n```http\nPOST / HTTP/1.1\nContent-Length: 129\nContent-Type: multipart/letter; boundary=c31279ab254f40aeb06df32b433cbccb\nHost: example.org\n\n--c31279ab254f40aeb06df32b433cbccb\nContent-Disposition: form-data; name=\"hello\"\n\nworld\n--c31279ab254f40aeb06df32b433cbccb--\n```\n\n## HTTP headers\n\nTo set custom headers you can use the `Header:Value` notation:\n\n```bash\n$ http pie.dev/headers User-Agent:Bacon/1.0 'Cookie:valued-visitor=yes;foo=bar' \\\n X-Foo:Bar Referer:https://httpie.org/\n```\n\n```http\nGET /headers HTTP/1.1\nAccept: */*\nAccept-Encoding: gzip, deflate\nCookie: valued-visitor=yes;foo=bar\nHost: pie.dev\nReferer: https://httpie.org/\nUser-Agent: Bacon/1.0\nX-Foo: Bar\n```\n\n### Default request headers\n\nThere are a couple of default headers that HTTPie sets:\n\n```http\nGET / HTTP/1.1\nAccept: */*\nAccept-Encoding: gzip, deflate\nUser-Agent: HTTPie/\nHost: \n```\n\nAll of these can be overwritten or unset (see below).\n\n### Reading headers from a file\n\nYou can read headers from a file by using the `:@` operator. This would also effectively strip the newlines from the end. See [file based separators](#file-based-separators) for more examples.\n\n```bash\n$ http pie.dev/headers X-Data:@files/text.txt\n```\n\n### Empty headers and header un-setting\n\nTo unset a previously specified header (such a one of the default headers), use `Header:`:\n\n```bash\n$ http pie.dev/headers Accept: User-Agent:\n```\n\nTo send a header with an empty value, use `Header;`, with a semicolon:\n\n```bash\n$ http pie.dev/headers 'Header;'\n```\n\nPlease note that some internal headers, such as `Content-Length`, can’t be unset if\nthey are automatically added by the client itself.\n\n### Multiple header values with the same name\n\nIf the request is sent with multiple headers that are sharing the same name, then\nthe HTTPie will send them individually.\n\n```bash\nhttp --offline example.org Cookie:one Cookie:two\n```\n\n```http\nGET / HTTP/1.1\nCookie: one\nCookie: two\n```\n\nIt is also possible to pass a single header value pair, where the value is a comma\nseparated list of header values. Then the client will send it as a single header.\n\n```bash\nhttp --offline example.org Numbers:one,two\n```\n\n```http\nGET / HTTP/1.1\nNumbers: one,two\n```\n\nAlso be aware that if the current session contains any headers they will get overwritten\nby individual commands when sending a request instead of being joined together.\n\n### Limiting response headers\n\nThe `--max-headers=n` option allows you to control the number of headers HTTPie reads before giving up (the default `0`, i.e., there’s no limit).\n\n```bash\n$ http --max-headers=100 pie.dev/get\n```\n\n## Offline mode\n\nUse `--offline` to construct HTTP requests without sending them anywhere.\nWith `--offline`, HTTPie builds a request based on the specified options and arguments, prints it to `stdout`, and then exits. It works completely offline; no network connection is ever made. This has a number of use cases, including:\n\nGenerating API documentation examples that you can copy & paste without sending a request:\n\n```bash\n$ http --offline POST server.chess/api/games API-Key:ZZZ w=magnus b=hikaru t=180 i=2\n```\n\n```bash\n$ http --offline MOVE server.chess/api/games/123 API-Key:ZZZ p=b a=R1a3 t=77\n```\n\nGenerating raw requests that can be sent with any other client:\n\n```bash\n# 1. save a raw request to a file:\n$ http --offline POST pie.dev/post hello=world > request.http\n```\n\n```bash\n# 2. send it over the wire with, for example, the fantastic netcat tool:\n$ nc pie.dev 80 < request.http\n```\n\nYou can also use the `--offline` mode for debugging and exploring HTTP and HTTPie, and for “dry runs”.\n\n`--offline` has the side effect of automatically activating `--print=HB`, i.e., both the request headers and the body\nare printed. You can customize the output with the usual [output options](#output-options), with the exception where there\nis no response to be printed. You can use `--offline` in combination with all the other options (e.g. `--session`).\n\n## Cookies\n\nHTTP clients send cookies to the server as regular [HTTP headers](#http-headers).\nThat means, HTTPie does not offer any special syntax for specifying cookies — the usual `Header:Value` notation is used:\n\nSend a single cookie:\n\n```bash\n$ http pie.dev/cookies Cookie:sessionid=foo\n```\n\n```http\nGET / HTTP/1.1\nAccept: */*\nAccept-Encoding: gzip, deflate\nConnection: keep-alive\nCookie: sessionid=foo\nHost: pie.dev\nUser-Agent: HTTPie/0.9.9\n```\n\nSend multiple cookies (note: the header is quoted to prevent the shell from interpreting the `;`):\n\n```bash\n$ http pie.dev/cookies 'Cookie:sessionid=foo;another-cookie=bar'\n```\n\n```http\nGET / HTTP/1.1\nAccept: */*\nAccept-Encoding: gzip, deflate\nConnection: keep-alive\nCookie: sessionid=foo;another-cookie=bar\nHost: pie.dev\nUser-Agent: HTTPie/0.9.9\n```\n\nIf you often deal with cookies in your requests, then you’d appreciate\nthe [sessions](#sessions) feature.\n\n## Authentication\n\nThe currently supported authentication schemes are Basic and Digest (see [auth plugins](#auth-plugins) for more). There are two flags that control authentication:\n\n| Flag | Arguments |\n|------------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `--auth, -a` | Pass either a `username:password` pair or a `token` as the argument. If the selected authenticated method requires username/password combination and if you only specify a username (`-a username`), you’ll be prompted for the password before the request is sent. To send an empty password, pass `username:`. The `username:password@hostname` URL syntax is supported as well (but credentials passed via `-a` have higher priority) |\n| `--auth-type, -A` | Specify the auth mechanism. Possible values are `basic`, `digest`, `bearer` or the name of any [auth plugins](#auth-plugins) you have installed. The default value is `basic` so it can often be omitted |\n\n### Basic auth\n\n```bash\n$ http -a username:password pie.dev/basic-auth/username/password\n```\n\n### Digest auth\n\n```bash\n$ http -A digest -a username:password pie.dev/digest-auth/httpie/username/password\n```\n\n### Bearer auth\n\n```bash\nhttps -A bearer -a token pie.dev/bearer\n```\n\n### Password prompt\n\nIf you omit the password part of `--auth, -a`, HTTPie securely prompts you for it:\n\n```bash\n$ http -a username pie.dev/basic-auth/username/password\n```\n\nPlease note that when you use [`--session`](#sessions), prompted passwords are persisted in session files.\n\n### Empty password\n\nTo send an empty password without being prompted for it, include a trailing colon in the credentials:\n\n```bash\n$ http -a username: pie.dev/headers\n```\n\n### `.netrc`\n\nAuthentication information from your `~/.netrc` file is by default honored as well.\n\nFor example:\n\n```bash\n$ cat ~/.netrc\nmachine pie.dev\nlogin httpie\npassword test\n```\n\n```bash\n$ http pie.dev/basic-auth/httpie/test\nHTTP/1.1 200 OK\n[...]\n```\n\nThis can be disabled with the `--ignore-netrc` option:\n\n```bash\n$ http --ignore-netrc pie.dev/basic-auth/httpie/test\nHTTP/1.1 401 UNAUTHORIZED\n[...]\n```\n\n### Auth plugins\n\nAdditional authentication mechanism can be installed as plugins.\nThey can be found on the [Python Package Index](https://pypi.python.org/pypi?%3Aaction=search&term=httpie&submit=search).\nHere are a few picks:\n\n- [httpie-api-auth](https://github.com/pd/httpie-api-auth): ApiAuth\n- [httpie-aws-auth](https://github.com/httpie/httpie-aws-auth): AWS / Amazon S3\n- [httpie-edgegrid](https://github.com/akamai-open/httpie-edgegrid): EdgeGrid\n- [httpie-hmac-auth](https://github.com/guardian/httpie-hmac-auth): HMAC\n- [httpie-jwt-auth](https://github.com/teracyhq/httpie-jwt-auth): JWTAuth (JSON Web Tokens)\n- [httpie-negotiate](https://github.com/ndzou/httpie-negotiate): SPNEGO (GSS Negotiate)\n- [httpie-ntlm](https://github.com/httpie/httpie-ntlm): NTLM (NT LAN Manager)\n- [httpie-oauth1](https://github.com/qcif/httpie-oauth1): OAuth 1.0a\n- [requests-hawk](https://github.com/mozilla-services/requests-hawk): Hawk\n\nSee [plugin manager](#plugin-manager) for more details.\n\n## HTTP redirects\n\nBy default, HTTP redirects are not followed and only the first\nresponse is shown:\n\n```bash\n$ http pie.dev/redirect/3\n```\n\n### Follow `Location`\n\nTo instruct HTTPie to follow the `Location` header of `30x` responses\nand show the final response instead, use the `--follow, -F` option:\n\n```bash\n$ http --follow pie.dev/redirect/3\n```\n\nWith `307 Temporary Redirect` and `308 Permanent Redirect`, the method and the body of the original request\nare reused to perform the redirected request. Otherwise, a body-less `GET` request is performed.\n\n### Showing intermediary redirect responses\n\nIf you wish to see the intermediary requests/responses,\nthen use the `--all` option:\n\n```bash\n$ http --follow --all pie.dev/redirect/3\n```\n\n### Limiting maximum redirects followed\n\nTo change the default limit of maximum `30` redirects, use the `--max-redirects=` option:\n\n```bash\n$ http --follow --all --max-redirects=2 pie.dev/redirect/3\n```\n\n## Proxies\n\nYou can specify proxies to be used through the `--proxy` argument for each protocol (which is included in the value in case of redirects across protocols):\n\n```bash\n$ http --proxy=http:http://10.10.1.10:3128 --proxy=https:https://10.10.1.10:1080 example.org\n```\n\nWith Basic authentication:\n\n```bash\n$ http --proxy=http:http://user:pass@10.10.1.10:3128 example.org\n```\n\n### Environment variables\n\nYou can also configure proxies by environment variables `ALL_PROXY`, `HTTP_PROXY` and `HTTPS_PROXY`, and the underlying\n[Requests library](https://requests.readthedocs.io/en/latest/) will pick them up.\nIf you want to disable proxies configured through the environment variables for certain hosts, you can specify them in `NO_PROXY`.\n\nIn your `~/.bash_profile`:\n\n```bash\nexport HTTP_PROXY=http://10.10.1.10:3128\nexport HTTPS_PROXY=https://10.10.1.10:1080\nexport NO_PROXY=localhost,example.com\n```\n\n### SOCKS\n\nUsage for SOCKS is the same as for other types of [proxies](#proxies):\n\n```bash\n$ http --proxy=http:socks5://user:pass@host:port --proxy=https:socks5://user:pass@host:port example.org\n```\n\n## HTTPS\n\n### Server SSL certificate verification\n\nTo skip the host’s SSL certificate verification, you can pass `--verify=no` (default is `yes`):\n\n```bash\n$ http --verify=no https://pie.dev/get\n```\n\n### Custom CA bundle\n\nYou can also use `--verify=` to set a custom CA bundle path:\n\n```bash\n$ http --verify=/ssl/custom_ca_bundle https://example.org\n```\n\n### Client side SSL certificate\n\nTo use a client side certificate for the SSL communication, you can pass\nthe path of the cert file with `--cert`:\n\n```bash\n$ http --cert=client.pem https://example.org\n```\n\nIf the private key is not contained in the cert file, you may pass the\npath of the key file with `--cert-key`:\n\n```bash\n$ http --cert=client.crt --cert-key=client.key https://example.org\n```\n\nIf the given private key requires a passphrase, HTTPie will automatically detect it\nand ask it through a prompt:\n\n```bash\n$ http --cert=client.pem --cert-key=client.key https://example.org\nhttp: passphrase for client.key: ****\n```\n\nIf you don't want to see a prompt, you can supply the passphrase with the `--cert-key-pass`\nargument:\n\n```bash\n$ http --cert=client.pem --cert-key=client.key --cert-key-pass=my_password https://example.org\n```\n\n### SSL version\n\nUse the `--ssl=` option to specify the desired protocol version to use.\nThis will default to SSL v2.3 which will negotiate the highest protocol that both the server and your installation of OpenSSL support.\nThe available protocols are `ssl2.3`, `ssl3`, `tls1`, `tls1.1`, `tls1.2`, `tls1.3`.\n(The actually available set of protocols may vary depending on your OpenSSL installation.)\n\n```bash\n# Specify the vulnerable SSL v3 protocol to talk to an outdated server:\n$ http --ssl=ssl3 https://vulnerable.example.org\n```\n\n### SSL ciphers\n\nYou can specify the available ciphers with `--ciphers`.\nIt should be a string in the [OpenSSL cipher list format](https://www.openssl.org/docs/man1.1.0/man1/ciphers.html).\n\n```bash\n$ http --ciphers=ECDHE-RSA-AES128-GCM-SHA256 https://pie.dev/get\n```\n\nNote: these cipher strings do not change the negotiated version of SSL or TLS, they only affect the list of available cipher suites.\n\nTo see the default cipher string, run `http --help` and see the `--ciphers` section under SSL.\n\n## Output options\n\nBy default, HTTPie only outputs the final response and the whole response\nmessage is printed (headers as well as the body). You can control what should\nbe printed via several options:\n\n| Option | What is printed |\n|---------------------------:|----------------------------------------------------------------------------------------------------|\n| `--headers, -h` | Only the response headers are printed |\n| `--body, -b` | Only the response body is printed |\n| `--meta, -m` | Only the [response metadata](#response-meta) is printed |\n| `--verbose, -v` | Print the whole HTTP exchange (request and response). This option also enables `--all` (see below) |\n| `--verbose --verbose, -vv` | Just like `-v`, but also include the response metadata. |\n| `--print, -p` | Selects parts of the HTTP exchange |\n| `--quiet, -q` | Don’t print anything to `stdout` and `stderr` |\n\n### What parts of the HTTP exchange should be printed\n\nAll the other [output options](#output-options) are under the hood just shortcuts for the more powerful `--print, -p`.\nIt accepts a string of characters each of which represents a specific part of the HTTP exchange:\n\n| Character | Stands for |\n|----------:|---------------------------------|\n| `H` | request headers |\n| `B` | request body |\n| `h` | response headers |\n| `b` | response body |\n| `m` | [response meta](#response-meta) |\n\nPrint request and response headers:\n\n```bash\n$ http --print=Hh PUT pie.dev/put hello=world\n```\n\n#### Response meta\n\nThe response metadata section currently includes the total time elapsed. It’s the number of seconds between opening the network connection and downloading the last byte of response the body.\n\n\nTo _only_ show the response metadata, use `--meta, -m` (analogically to `--headers, -h` and `--body, -b`):\n\n```bash\n$ http --meta pie.dev/delay/1\n```\n\n```console\nElapsed time: 1.099171542s\n```\n\nThe [extra verbose `-vv` output](#extra-verbose-output) includes the meta section by default. You can also show it in combination with other parts of the exchange via [`--print=m`](#what-parts-of-the-http-exchange-should-be-printed). For example, here we print it together with the response headers:\n\n```bash\n$ http --print=hm pie.dev/get\n```\n\n```http\nHTTP/1.1 200 OK\nContent-Type: application/json\n\nElapsed time: 0.077538375s\n```\n\n\nPlease note that it also includes time spent on formatting the output, which adds a small penalty. Also, if the body is not part of the output, [we don’t spend time downloading it](#conditional-body-download).\n\nIf you [use `--style` with one of the Pie themes](#colors-and-formatting), you’ll see the time information color-coded (green/yellow/orange/red) based on how long the exchange took.\n\n\n### Verbose output\n\n`--verbose` can often be useful for debugging the request and generating documentation examples:\n\n```bash\n$ http --verbose PUT pie.dev/put hello=world\nPUT /put HTTP/1.1\nAccept: application/json, */*;q=0.5\nAccept-Encoding: gzip, deflate\nContent-Type: application/json\nHost: pie.dev\nUser-Agent: HTTPie/0.2.7dev\n\n{\n \"hello\": \"world\"\n}\n\nHTTP/1.1 200 OK\nConnection: keep-alive\nContent-Length: 477\nContent-Type: application/json\nDate: Sun, 05 Aug 2012 00:25:23 GMT\nServer: gunicorn/0.13.4\n\n{\n […]\n}\n```\n\n#### Extra verbose output\n\nIf you run HTTPie with `-vv` or `--verbose --verbose`, then it would also display the [response metadata](#response-meta).\n\n```bash\n# Just like the above, but with additional columns like the total elapsed time\n$ http -vv pie.dev/get\n```\n\n### Quiet output\n\n`--quiet` redirects all output that would otherwise go to `stdout` and `stderr` to `/dev/null` (except for errors and warnings).\nThis doesn’t affect output to a file via `--output` or `--download`.\n\n```bash\n# There will be no output:\n$ http --quiet pie.dev/post enjoy='the silence'\n```\n\nIf you’d like to silence warnings as well, use `-q` or `--quiet` twice:\n\n```bash\n# There will be no output, even in case of an unexpected response status code:\n$ http -qq --check-status pie.dev/post enjoy='the silence without warnings'\n```\n\n### Update warnings\n\nWhen there is a new release available for your platform (for example; if you installed HTTPie through `pip`, it will check the latest version on `PyPI`), HTTPie will regularly warn you about the new update (once a week). If you want to disable this behavior, you can set `disable_update_warnings` to `true` in your [config](#config) file.\n\n### Viewing intermediary requests/responses\n\nTo see all the HTTP communication, i.e. the final request/response as well as any possible intermediary requests/responses, use the `--all` option.\nThe intermediary HTTP communication include followed redirects (with `--follow`), the first unauthorized request when HTTP digest authentication is used (`--auth=digest`), etc.\n\n```bash\n# Include all responses that lead to the final one:\n$ http --all --follow pie.dev/redirect/3\n```\n\nThe intermediary requests/responses are by default formatted according to `--print, -p` (and its shortcuts described above).\n\n### Conditional body download\n\nAs an optimization, the response body is downloaded from the server only if it’s part of the output.\nThis is similar to performing a `HEAD` request, except that it applies to any HTTP method you use.\n\nLet’s say that there is an API that returns the whole resource when it is updated, but you are only interested in the response headers to see the status code after an update:\n\n```bash\n$ http --headers PATCH pie.dev/patch name='New Name'\n```\n\nSince you are only printing the HTTP headers here, the connection to the server is closed as soon as all the response headers have been received.\nTherefore, bandwidth and time isn’t wasted downloading the body which you don’t care about.\nThe response headers are downloaded always, even if they are not part of the output\n\n## Raw request body\n\nIn addition to crafting structured [JSON](#json) and [forms](#forms) requests with the [request items](#request-items) syntax, you can provide a raw request body that will be sent without further processing.\nThese two approaches for specifying request data (i.e., structured and raw) cannot be combined.\n\nThere are three methods for passing raw request data: piping via `stdin`,\n`--raw='data'`, and `@/file/path`.\n\n### Redirected Input\n\nThe universal method for passing request data is through redirected `stdin`\n(standard input)—piping.\n\nBy default, `stdin` data is buffered and then with no further processing used as the request body.\nIf you provide `Content-Length`, then the request body is streamed without buffering.\nYou may also use `--chunked` to enable streaming via [chunked transfer encoding](#chunked-transfer-encoding)\nor `--compress, -x` to [compress the request body](#compressed-request-body).\n\nThere are multiple useful ways to use piping:\n\nRedirect from a file:\n\n```bash\n$ http PUT pie.dev/put X-API-Token:123 < files/data.json\n```\n\nOr the output of another program:\n\n```bash\n$ grep '401 Unauthorized' /var/log/httpd/error_log | http POST pie.dev/post\n```\n\nYou can use `echo` for simple data:\n\n```bash\n$ echo -n '{\"name\": \"John\"}' | http PATCH pie.dev/patch X-API-Token:123\n```\n\nYou can also use a Bash *here string*:\n\n```bash\n$ http pie.dev/post <<<'{\"name\": \"John\"}'\n```\n\nYou can even pipe web services together using HTTPie:\n\n```bash\n$ http GET https://api.github.com/repos/httpie/cli | http POST pie.dev/post\n```\n\nYou can use `cat` to enter multiline data on the terminal:\n\n```bash\n$ cat | http POST pie.dev/post\n\n^D\n```\n\n```bash\n$ cat | http POST pie.dev/post Content-Type:text/plain\n- buy milk\n- call parents\n^D\n```\n\nOn macOS, you can send the contents of the clipboard with `pbpaste`:\n\n```bash\n$ pbpaste | http PUT pie.dev/put\n```\n\nPassing data through `stdin` **can’t** be combined with data fields specified on the command line:\n\n```bash\n$ echo -n 'data' | http POST example.org more=data # This is invalid\n```\n\nTo prevent HTTPie from reading `stdin` data you can use the `--ignore-stdin` option.\n\n### Request data via `--raw`\n\nIn a situation when piping data via `stdin` is not convenient (for example,\nwhen generating API docs examples), you can specify the raw request body via\nthe `--raw` option.\n\n```bash\n$ http --raw 'Hello, world!' pie.dev/post\n```\n\n```bash\n$ http --raw '{\"name\": \"John\"}' pie.dev/post\n```\n\n### Request data from a filename\n\nAn alternative to redirected `stdin` is specifying a filename (as `@/path/to/file`) whose content is used as if it came from `stdin`.\n\nIt has the advantage that the `Content-Type` header is automatically set to the appropriate value based on the filename extension.\nFor example, the following request sends the verbatim contents of that XML file with `Content-Type: application/xml`:\n\n```bash\n$ http PUT pie.dev/put @files/data.xml\n```\n\nFile uploads are always streamed to avoid memory issues with large files.\n\n## Chunked transfer encoding\n\nYou can use the `--chunked` flag to instruct HTTPie to use `Transfer-Encoding: chunked`:\n\n```bash\n$ http --chunked PUT pie.dev/put hello=world\n```\n\n```bash\n$ http --chunked --multipart PUT pie.dev/put hello=world foo@files/data.xml\n```\n\n```bash\n$ http --chunked pie.dev/post @files/data.xml\n```\n\n```bash\n$ cat files/data.xml | http --chunked pie.dev/post\n```\n\n## Compressed request body\n\nYou can use the `--compress, -x` flag to instruct HTTPie to use `Content-Encoding: deflate` and compress the request data:\n\n```bash\n$ http --compress pie.dev/post @files/data.xml\n```\n\n```bash\n$ cat files/data.xml | http --compress pie.dev/post\n```\n\nIf compressing the data does not save size, HTTPie sends it untouched. To always compress the data, specify `--compress, -x` twice:\n\n```bash\n$ http -xx PUT pie.dev/put hello=world\n```\n\n## Terminal output\n\nHTTPie does several things by default in order to make its terminal output easy to read.\n\n### Colors and formatting\n\nSyntax highlighting is applied to HTTP headers and bodies (where it makes sense).\nYou can choose your preferred color scheme via the `--style` option if you don’t like the default one.\nThere are dozens of styles available, here are just a few notable ones:\n\n| Style | Description |\n|------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `auto` | Follows your terminal ANSI color styles. This is the default style used by HTTPie |\n| `default` | Default styles of the underlying Pygments library. Not actually used by default by HTTPie. You can enable it with `--style=default` |\n| `pie-dark` | HTTPie’s original brand style. Also used in [HTTPie for Web and Desktop](https://httpie.io/product). |\n| `pie-light` | Like `pie-dark`, but for terminals with light background colors. |\n| `pie` | A generic version of `pie-dark` and `pie-light` themes that can work with any terminal background. Its universality requires compromises in terms of legibility, but it’s useful if you frequently switch your terminal between dark and light backgrounds. |\n| `monokai` | A popular color scheme. Enable with `--style=monokai` |\n| `fruity` | A bold, colorful scheme. Enable with `--style=fruity` |\n| … | See `$ http --help` for all the possible `--style` values |\n\nUse one of these options to control output processing:\n\n| Option | Description |\n|------------------:|---------------------------------------------------------------|\n| `--pretty=all` | Apply both colors and formatting. Default for terminal output |\n| `--pretty=colors` | Apply colors |\n| `--pretty=format` | Apply formatting |\n| `--pretty=none` | Disables output processing. Default for redirected output |\n\nHTTPie looks at `Content-Type` to select the right syntax highlighter and formatter for each message body. If that fails (e.g., the server provides the wrong type), or you prefer a different treatment, you can manually overwrite the mime type for a response with `--response-mime`:\n\n```bash\n$ http --response-mime=text/yaml pie.dev/get\n```\n\nFormatting has the following effects:\n\n- HTTP headers are sorted by name.\n- JSON data is indented, sorted by keys, and unicode escapes are converted\n to the characters they represent.\n- XML and XHTML data is indented.\n\nPlease note that sometimes there might be changes made by formatters on the actual response body (e.g.,\ncollapsing empty tags on XML) but the end result will always be semantically indistinguishable. Some of\nthese formatting changes can be configured more granularly through [format options](#format-options).\n\n### Format options\n\nThe `--format-options=opt1:value,opt2:value` option allows you to control how the output should be formatted\nwhen formatting is applied. The following options are available:\n\n| Option | Default value | Shortcuts |\n|-----------------:|:-------------:|--------------------------|\n| `headers.sort` | `true` | `--sorted`, `--unsorted` |\n| `json.format` | `true` | N/A |\n| `json.indent` | `4` | N/A |\n| `json.sort_keys` | `true` | `--sorted`, `--unsorted` |\n| `xml.format` | `true` | N/A |\n| `xml.indent` | `2` | N/A |\n\nFor example, this is how you would disable the default header and JSON key\nsorting, and specify a custom JSON indent size:\n\n```bash\n$ http --format-options headers.sort:false,json.sort_keys:false,json.indent:2 pie.dev/get\n```\n\nThere are also two shortcuts that allow you to quickly disable and re-enable\nsorting-related format options (currently it means JSON keys and headers):\n`--unsorted` and `--sorted`.\n\nThis is something you will typically store as one of the default options in your [config](#config) file.\n\n### Redirected output\n\nHTTPie uses a different set of defaults for redirected output than for [terminal output](#terminal-output).\nThe differences being:\n\n- Formatting and colors aren’t applied (unless `--pretty` is specified).\n- Only the response body is printed (unless one of the [output options](#output-options) is set).\n- Also, binary data isn’t suppressed.\n\nThe reason is to make piping HTTPie’s output to another programs and downloading files work with no extra flags.\nMost of the time, only the raw response body is of an interest when the output is redirected.\n\nDownload a file:\n\n```bash\n$ http pie.dev/image/png > image.png\n```\n\nDownload an image of an [Octocat](https://octodex.github.com/images/original.jpg), resize it using [ImageMagick](https://imagemagick.org/), and upload it elsewhere:\n\n```bash\n$ http octodex.github.com/images/original.jpg | convert - -resize 25% - | http example.org/Octocats\n```\n\nForce colorizing and formatting, and show both the request and the response in `less` pager:\n\n```bash\n$ http --pretty=all --verbose pie.dev/get | less -R\n```\n\nThe `-R` flag tells `less` to interpret color escape sequences included HTTPie’s output.\n\nYou can create a shortcut for invoking HTTPie with colorized and paged output by adding the following to your `~/.bash_profile`:\n\n```bash\nfunction httpless {\n # `httpless example.org'\n http --pretty=all --print=hb \"$@\" | less -R;\n}\n```\n\n### Binary data\n\nBinary data is suppressed for terminal output, which makes it safe to perform requests to URLs that send back binary data.\nBinary data is also suppressed in redirected but prettified output.\nThe connection is closed as soon as we know that the response body is binary,\n\n```bash\n$ http pie.dev/bytes/2000\n```\n\nYou will nearly instantly see something like this:\n\n```http\nHTTP/1.1 200 OK\nContent-Type: application/octet-stream\n\n+-----------------------------------------+\n| NOTE: binary data not shown in terminal |\n+-----------------------------------------+\n```\n\n### Display encoding\n\nHTTPie tries to do its best to decode message bodies when printing them to the terminal correctly. It uses the encoding specified in the `Content-Type` `charset` attribute. If a message doesn’t define its charset, we auto-detect it. For very short messages (1–32B), where auto-detection would be unreliable, we default to UTF-8. For cases when the response encoding is still incorrect, you can manually overwrite the response charset with `--response-charset`:\n\n```bash\n$ http --response-charset=big5 pie.dev/get\n```\n\n## Download mode\n\nHTTPie features a download mode in which it acts similarly to `wget`.\n\nWhen enabled using the `--download, -d` flag, response headers are printed to the terminal (`stderr`), and a progress bar is shown while the response body is being saved to a file.\n\n```bash\n$ http --download https://github.com/httpie/cli/archive/master.tar.gz\n```\n\n```http\nHTTP/1.1 200 OK\nContent-Disposition: attachment; filename=httpie-master.tar.gz\nContent-Length: 257336\nContent-Type: application/x-gzip\n\nDownloading 251.30 kB to \"httpie-master.tar.gz\"\nDone. 251.30 kB in 2.73862s (91.76 kB/s)\n```\n\n### Downloaded filename\n\nThere are three mutually exclusive ways through which HTTPie determines\nthe output filename (with decreasing priority):\n\n1. You can explicitly provide it via `--output, -o`. The file gets overwritten if it already exists (or appended to with `--continue, -c`).\n2. The server may specify the filename in the optional `Content-Disposition` response header. Any leading dots are stripped from a server-provided filename.\n3. The last resort HTTPie uses is to generate the filename from a combination of the request URL and the response `Content-Type`. The initial URL is always used as the basis for the generated filename — even if there has been one or more redirects.\n\nTo prevent data loss by overwriting, HTTPie adds a unique numerical suffix to the filename when necessary (unless specified with `--output, -o`).\n\n### Piping while downloading\n\nYou can also redirect the response body to another program while the response headers and progress are still shown in the terminal:\n\n```bash\n$ http -d https://github.com/httpie/cli/archive/master.tar.gz | tar zxf -\n```\n\n### Resuming downloads\n\nIf `--output, -o` is specified, you can resume a partial download using the `--continue, -c` option.\nThis only works with servers that support `Range` requests and `206 Partial Content` responses.\nIf the server doesn’t support that, the whole file will simply be downloaded:\n\n```bash\n$ http -dco file.zip example.org/file\n```\n\n`-dco` is shorthand for `--download` `--continue` `--output`.\n\n### Other notes\n\n- The `--download` option only changes how the response body is treated.\n- You can still set custom headers, use sessions, `--verbose, -v`, etc.\n- `--download` always implies `--follow` (redirects are followed).\n- `--download` also implies `--check-status` (error HTTP status will result in a non-zero exist static code).\n- HTTPie exits with status code `1` (error) if the body hasn’t been fully downloaded.\n- `Accept-Encoding` can’t be set with `--download`.\n\n## Streamed responses\n\nResponses are downloaded and printed in chunks.\nThis allows for streaming and large file downloads without using too much memory.\nHowever, when [colors and formatting](#colors-and-formatting) are applied, the whole response is buffered and only then processed at once.\n\n### Disabling buffering\n\nYou can use the `--stream, -S` flag to make two things happen:\n\n1. The output is flushed in much smaller chunks without any buffering, which makes HTTPie behave kind of like `tail -f` for URLs.\n2. Streaming becomes enabled even when the output is prettified: It will be applied to each line of the response and flushed immediately. This makes it possible to have a nice output for long-lived requests, such as one to the [Twitter streaming API](https://developer.twitter.com/en/docs/tutorials/consuming-streaming-data).\n\nThe `--stream` option is automatically enabled when the response headers include `Content-Type: text/event-stream`.\n\n### Example use cases\n\nPrettified streamed response:\n\n```bash\n$ http --stream pie.dev/stream/3\n```\n\nStreamed output by small chunks à la `tail -f`:\n\n```bash\n# Send each new line (JSON object) to another URL as soon as it arrives from a streaming API:\n$ http --stream pie.dev/stream/3 | while read line; do echo \"$line\" | http pie.dev/post ; done\n```\n\n## Sessions\n\nBy default, every request HTTPie makes is completely independent of any previous ones to the same host.\n\nHowever, HTTPie also supports persistent sessions via the `--session=SESSION_NAME_OR_PATH` option.\nIn a session, custom [HTTP headers](#http-headers) (except for the ones starting with `Content-` or `If-`), [authentication](#authentication), and [cookies](#cookies) (manually specified or sent by the server) persist between requests to the same host.\n\n```bash\n# Create a new session:\n$ http --session=./session.json pie.dev/headers API-Token:123\n```\n\n```bash\n# Inspect / edit the generated session file:\n$ cat session.json\n```\n\n```bash\n# Re-use the existing session — the API-Token header will be set:\n$ http --session=./session.json pie.dev/headers\n```\n\nAll session data, including credentials, prompted passwords, cookie data, and custom headers are stored in plain text.\nThat means session files can also be created and edited manually in a text editor—they are regular JSON.\nIt also means that they can be read by anyone who has access to the session file.\n\n### Named sessions\n\nYou can create one or more named session per host. For example, this is how you can create a new session named `user1` for `pie.dev`:\n\n```bash\n$ http --session=user1 -a user1:password pie.dev/get X-Foo:Bar\n```\n\nFrom now on, you can refer to the session by its name (`user1`).\nWhen you choose to use the session again, all previously specified authentication or HTTP headers will automatically be set:\n\n```bash\n$ http --session=user1 pie.dev/get\n```\n\nTo create or reuse a different session, simply specify a different name:\n\n```bash\n$ http --session=user2 -a user2:password pie.dev/get X-Bar:Foo\n```\n\nNamed sessions’ data is stored in JSON files inside the `sessions` subdirectory of the [config](#config) directory, typically `~/.config/httpie/sessions//.json` (`%APPDATA%\\httpie\\sessions\\\\.json` on Windows).\n\nIf you have executed the above commands on a Unix machine, you should be able to list the generated sessions files using:\n\n```bash\n$ ls -l ~/.config/httpie/sessions/pie.dev\n```\n\n### Anonymous sessions\n\nInstead of giving it a name, you can also directly specify a path to a session file.\nThis allows for sessions to be re-used across multiple hosts:\n\n```bash\n# Create a session:\n$ http --session=/tmp/session.json example.org\n```\n\n```bash\n# Use the session to make a request to another host:\n$ http --session=/tmp/session.json admin.example.org\n```\n\n```bash\n# You can also refer to a previously created named session:\n$ http --session=~/.config/httpie/sessions/another.example.org/test.json example.org\n```\n\nWhen creating anonymous sessions, please remember to always include at least one `/`, even if the session files is located in the current directory (i.e. `--session=./session.json` instead of just `--session=session.json`), otherwise HTTPie assumes a named session instead.\n\n### Readonly session\n\nTo use the original session file without updating it from the request/response exchange after it has been created, specify the session name via `--session-read-only=SESSION_NAME_OR_PATH` instead.\n\n```bash\n# If the session file doesn’t exist, then it is created:\n$ http --session-read-only=./ro-session.json pie.dev/headers Custom-Header:orig-value\n```\n\n```bash\n# But it is not updated:\n$ http --session-read-only=./ro-session.json pie.dev/headers Custom-Header:new-value\n```\n\n### Host-based cookie policy\n\nCookies persisted in sessions files have a `domain` field. This _binds_ them to a specified hostname. For example:\n\n```json\n{\n \"cookies\": [\n {\n \"domain\": \"pie.dev\",\n \"name\": \"pie\",\n \"value\": \"apple\"\n },\n {\n \"domain\": \"httpbin.org\",\n \"name\": \"bin\",\n \"value\": \"http\"\n }\n ]\n}\n```\n\nUsing this session file, we include `Cookie: pie=apple` only in requests against `pie.dev` and subdomains (e.g., `foo.pie.dev` or `foo.bar.pie.dev`):\n\n```bash\n$ http --session=./session.json pie.dev/cookies\n```\n\n```json\n{\n \"cookies\": {\n \"pie\": \"apple\"\n }\n}\n```\n\nTo make a cookie domain _unbound_ (i.e., to make it available to all hosts, including throughout a cross-domain redirect chain), you can set the `domain` field to `null` in the session file:\n\n```json\n{\n \"cookies\": [\n {\n \"domain\": null,\n \"name\": \"unbound-cookie\",\n \"value\": \"send-me-to-any-host\"\n }\n ]\n}\n```\n\n```bash\n$ http --session=./session.json pie.dev/cookies\n```\n\n```json\n{\n \"cookies\": {\n \"unbound-cookie\": \"send-me-to-any-host\"\n }\n}\n```\n\n\n### Cookie storage behavior\n\nThere are three possible sources of persisted cookies within a session. They have the following storage priority: 1—response; 2—command line; 3—session file.\n\n1. Receive a response with a `Set-Cookie` header:\n\n ```bash\n $ http --session=./session.json pie.dev/cookie/set?foo=bar\n ```\n\n2. Send a cookie specified on the command line as seen in [cookies](#cookies):\n\n ```bash\n $ http --session=./session.json pie.dev/headers Cookie:foo=bar\n ```\n\n3. Manually set cookie parameters in the session file:\n\n ```json\n {\n \"cookies\": {\n \"foo\": {\n \"expires\": null,\n \"path\": \"/\",\n \"secure\": false,\n \"value\": \"bar\"\n }\n }\n }\n ```\n\nIn summary:\n\n- Cookies set via the CLI overwrite cookies of the same name inside session files.\n- Server-sent `Set-Cookie` header cookies overwrite any pre-existing ones with the same name.\n\nCookie expiration handling:\n\n- When the server expires an existing cookie, HTTPie removes it from the session file.\n- When a cookie in a session file expires, HTTPie removes it before sending a new request.\n\n### Upgrading sessions\n\nHTTPie may introduce changes in the session file format. When HTTPie detects an obsolete format, it shows a warning. You can upgrade your session files using the following commands:\n\nUpgrade all existing [named sessions](#named-sessions) inside the `sessions` subfolder of your [config directory](https://httpie.io/docs/cli/config-file-directory):\n\n```bash\n$ httpie cli sessions upgrade-all\nUpgraded 'api_auth' @ 'pie.dev' to v3.1.0\nUpgraded 'login_cookies' @ 'httpie.io' to v3.1.0\n```\n\nUpgrading individual sessions requires you to specify the session's hostname. That allows HTTPie to find the correct file in the case of name sessions. Additionally, it allows it to correctly bind cookies when upgrading with [`--bind-cookies`](#session-upgrade-options).\n\nUpgrade a single [named session](#named-sessions):\n\n```bash\n$ httpie cli sessions upgrade pie.dev api_auth\nUpgraded 'api_auth' @ 'pie.dev' to v3.1.0\n```\n\nUpgrade a single [anonymous session](#anonymous-sessions) using a file path:\n\n```bash\n$ httpie cli sessions upgrade pie.dev ./session.json\nUpgraded 'session.json' @ 'pie.dev' to v3.1.0\n```\n\n#### Session upgrade options\n\nThese flags are available for both `sessions upgrade` and `sessions upgrade-all`:\n\n| Option | Description |\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `--bind-cookies` | Bind all previously [unbound cookies](#host-based-cookie-policy) to the session’s host ([context](https://github.com/httpie/cli/security/advisories/GHSA-9w4w-cpc8-h2fq)). |\n\n\n## Config\n\nHTTPie uses a simple `config.json` file.\nThe file doesn’t exist by default, but you can create it manually.\n\n### Config file directory\n\nTo see the exact location for your installation, run `http --debug` and look for `config_dir` in the output.\n\nThe default location of the configuration file on most platforms is `$XDG_CONFIG_HOME/httpie/config.json` (defaulting to `~/.config/httpie/config.json`).\n\nFor backward compatibility, if the directory `~/.httpie` exists, the configuration file there will be used instead.\n\nOn Windows, the config file is located at `%APPDATA%\\httpie\\config.json`.\n\nThe config directory can be changed by setting the `$HTTPIE_CONFIG_DIR` environment variable:\n\n```bash\n$ export HTTPIE_CONFIG_DIR=/tmp/httpie\n$ http pie.dev/get\n```\n\n### Configurable options\n\nCurrently, HTTPie offers a single configurable option:\n\n#### `default_options`\n\nAn `Array` (by default empty) of default options that should be applied to every invocation of HTTPie.\n\nFor instance, you can use this config option to change your default color theme:\n\n```bash\n$ cat ~/.config/httpie/config.json\n```\n\n```json\n{\n \"default_options\": [\n \"--style=fruity\"\n ]\n}\n```\n\nTechnically, it is possible to include any HTTPie options in there.\nHowever, it is not recommended modifying the default behavior in a way that would break your compatibility with the wider world as that may become confusing.\n\n#### `plugins_dir`\n\nThe directory where the plugins will be installed. HTTPie needs to have read/write access on that directory, since\n`httpie cli plugins install` will download new plugins to there. See [plugin manager](#plugin-manager) for more information.\n\n### Un-setting previously specified options\n\nDefault options from the config file, or specified any other way, can be unset for a particular invocation via `--no-OPTION` arguments passed via the command line (e.g., `--no-style` or `--no-session`).\n\n## Scripting\n\nWhen using HTTPie from shell scripts, it can be handy to set the `--check-status` flag.\nIt instructs HTTPie to exit with an error if the HTTP status is one of `3xx`, `4xx`, or `5xx`.\nThe exit status will be `3` (unless `--follow` is set), `4`, or `5`, respectively.\n\n```bash\n#!/bin/bash\n\nif http --check-status --ignore-stdin --timeout=2.5 HEAD pie.dev/get &> /dev/null; then\n echo 'OK!'\nelse\n case $? in\n 2) echo 'Request timed out!' ;;\n 3) echo 'Unexpected HTTP 3xx Redirection!' ;;\n 4) echo 'HTTP 4xx Client Error!' ;;\n 5) echo 'HTTP 5xx Server Error!' ;;\n 6) echo 'Exceeded --max-redirects= redirects!' ;;\n *) echo 'Other Error!' ;;\n esac\nfi\n```\n\n### Best practices\n\nThe default behavior of automatically reading `stdin` is typically not desirable during non-interactive invocations.\nYou most likely want to use the `--ignore-stdin` option to disable it.\n\nIt's important to note that without the `--ignore-stdin` option, HTTPie may appear to have stopped working (hang). This happens because, in situations where HTTPie is invoked outside of an interactive session, such as from a cron job, `stdin` is not connected to a terminal. This means that the rules for [redirected input](#redirected-input) will be followed. When `stdin` is redirected, HTTPie assumes that the input will contain the request body, and it waits for the input to be provided. But, since there is neither any input data nor an end-of-file (`EOF`) signal, HTTPie gets stuck. To avoid this problem, the `--ignore-stdin` flag should be used in scripts, unless data is being piped to HTTPie.\n\nTo prevent your program from becoming unresponsive when the server fails to respond, it's a good idea to use the `--timeout` option to set a connection timeout limit.\n\n## Plugin manager\n\nHTTPie offers extensibility through a [plugin API](https://github.com/httpie/cli/blob/master/httpie/plugins/base.py),\nand there are dozens of plugins available to try!\nThey add things like new authentication methods ([akamai/httpie-edgegrid](https://github.com/akamai/httpie-edgegrid)),\ntransport mechanisms ([httpie/httpie-unixsocket](https://github.com/httpie/httpie-unixsocket)),\nmessage convertors ([banteg/httpie-image](https://github.com/banteg/httpie-image)), or simply\nchange how a response is formatted.\n\n> Note: Plugins are usually made by our community members, and thus have no direct relationship with\n> the HTTPie project. We do not control / review them at the moment, so use them at your own discretion.\n\nFor managing these plugins; starting with 3.0, we are offering a new plugin manager.\n\nThis command is currently in beta.\n\n### `httpie cli`\n\n#### `httpie cli check-updates`\n\nYou can check whether a new update is available for your system by running `httpie cli check-updates`:\n\n```bash-termible\n$ httpie cli check-updates\n```\n\n#### `httpie cli export-args`\n\n`httpie cli export-args` command can expose the parser specification of `http`/`https` commands\n(like an API definition) to outside tools so that they can use this to build better interactions\nover them (e.g., offer auto-complete).\n\nAvailable formats to export in include:\n\n| Format | Description |\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `json` | Export the parser spec in JSON. The schema includes a top-level `version` parameter which should be interpreted in [semver](https://semver.org/). |\n\nYou can use any of these formats with `--format` parameter, but the default one is `json`.\n\n```bash\n$ httpie cli export-args | jq '\"Program: \" + .spec.name + \", Version: \" + .version'\n\"Program: http, Version: 0.0.1a0\"\n```\n\n#### `httpie cli plugins`\n\n`plugins` interface is a very simple plugin manager for installing, listing and uninstalling HTTPie plugins.\n\nIn the past `pip` was used to install/uninstall plugins, but on some environments (e.g., brew installed\npackages) it wasn’t working properly. The new interface is a very simple overlay on top of `pip` to allow\nplugin installations on every installation method.\n\nBy default, the plugins (and their missing dependencies) will be stored under the configuration directory,\nbut this can be modified through `plugins_dir` variable on the config.\n\n##### `httpie cli plugins install`\n\nFor installing plugins from [PyPI](https://pypi.org/) or from local paths, `httpie cli plugins install`\ncan be used.\n\n```bash\n$ httpie cli plugins install httpie-plugin\nInstalling httpie-plugin...\nSuccessfully installed httpie-plugin-1.0.2\n```\n\n> Tip: Generally HTTPie plugins start with `httpie-` prefix. Try searching for it on [PyPI](https://pypi.org/search/?q=httpie-)\n> to find out all plugins from the community.\n\n##### `httpie cli plugins list`\n\nList all installed plugins.\n\n```bash\n$ httpie cli plugins list\nhttpie_plugin (1.0.2)\n httpie_plugin (httpie.plugins.auth.v1)\nhttpie_plugin_2 (1.0.6)\n httpie_plugin_2 (httpie.plugins.auth.v1)\nhttpie_converter (1.0.0)\n httpie_iterm_converter (httpie.plugins.converter.v1)\n httpie_konsole_konverter (httpie.plugins.converter.v1)\n```\n\n##### `httpie cli plugins upgrade`\n\nFor upgrading already installed plugins, use `httpie plugins upgrade`.\n\n```bash\n$ httpie cli plugins upgrade httpie-plugin\n```\n\n##### `httpie cli plugins uninstall`\n\nUninstall plugins from the isolated plugins directory. If the plugin is not installed\nthrough `httpie cli plugins install`, it won’t uninstall it.\n\n```bash\n$ httpie cli plugins uninstall httpie-plugin\n```\n\n## Meta\n\n### Interface design\n\nThe syntax of the command arguments closely correspond to the actual HTTP requests sent over the wire.\nIt has the advantage that it’s easy to remember and read.\nYou can often translate an HTTP request to an HTTPie argument list just by inlining the request elements.\nFor example, compare this HTTP request:\n\n```http\nPOST /post HTTP/1.1\nHost: pie.dev\nX-API-Key: 123\nUser-Agent: Bacon/1.0\nContent-Type: application/x-www-form-urlencoded\n\nname=value&name2=value2\n```\n\nwith the HTTPie command that sends it:\n\n```bash\n$ http -f POST pie.dev/post \\\n X-API-Key:123 \\\n User-Agent:Bacon/1.0 \\\n name=value \\\n name2=value2\n```\n\nNotice that both the order of elements and the syntax are very similar, and that only a small portion of the command is used to control HTTPie and doesn’t directly correspond to any part of the request (here, it’s only `-f` asking HTTPie to send a form request).\n\nThe two modes, `--pretty=all` (default for terminal) and `--pretty=none` (default for [redirected output](#redirected-output)), allow for both user-friendly interactive use and usage from scripts, where HTTPie serves as a generic HTTP client.\n\nIn the future, the command line syntax and some of the `--OPTIONS` may change slightly, as HTTPie improves and new features are added.\nAll changes are recorded in the [change log](#change-log).\n\n### Community and Support\n\nHTTPie has the following community channels:\n\n- [GitHub Issues](https://github.com/httpie/cli/issues) for bug reports and feature requests\n- [Discord server](https://httpie.io/discord) to ask questions, discuss features, and for general API development discussion\n- [StackOverflow](https://stackoverflow.com) to ask questions (make sure to use the [httpie](https://stackoverflow.com/questions/tagged/httpie) tag)\n\n### Related projects\n\n#### Dependencies\n\nUnder the hood, HTTPie uses these two amazing libraries:\n\n- [Requests](https://requests.readthedocs.io/en/latest/) — Python HTTP library for humans\n- [Pygments](https://pygments.org/) — Python syntax highlighter\n\n#### HTTPie friends\n\nHTTPie plays exceptionally well with the following tools:\n\n- [http-prompt](https://github.com/httpie/http-prompt) — an interactive shell for HTTPie featuring autocomplete and command syntax highlighting\n- [jq](https://stedolan.github.io/jq/) — CLI JSON processor that works great in conjunction with HTTPie\n\nHelpers to convert from other client tools:\n\n- [CurliPie](https://curlipie.open-api.vn) — library to convert cURL commands to HTTPie\n\n#### Alternatives\n\n- [httpcat](https://github.com/httpie/httpcat) — a lower-level sister utility of HTTPie for constructing raw HTTP requests on the command line\n- [curl](https://curl.haxx.se) — a \"Swiss knife\" command line tool and an exceptional library for transferring data with URLs.\n\n### Contributing\n\nSee [CONTRIBUTING](https://github.com/httpie/cli/blob/master/CONTRIBUTING.md).\n\n### Security policy\n\nSee [github.com/httpie/cli/security/policy](https://github.com/httpie/cli/security/policy).\n\n### Change log\n\nSee [CHANGELOG](https://github.com/httpie/cli/blob/master/CHANGELOG.md).\n\n### Artwork\n\n- [README Animation](https://github.com/httpie/cli/blob/master/docs/httpie-animation.gif) by [Allen Smith](https://github.com/loranallensmith).\n\n### Licence\n\nBSD-3-Clause: [LICENSE](https://github.com/httpie/cli/blob/master/LICENSE).\n\n### Authors\n\n[Jakub Roztocil](https://roztocil.co) ([@jakubroztocil](https://twitter.com/jakubroztocil)) created HTTPie and [these fine people](https://github.com/httpie/cli/blob/master/AUTHORS.md) have contributed.\n\n" }, { "path": "docs/config.json", "content": "{\n \"website\": {\n \"master_and_released_docs_differ_after\": null\n }\n}\n" }, { "path": "docs/contributors/README.md", "content": "Here we maintain a database of contributors, from which we generate credits on release blog posts and social media.\n\nFor the HTTPie blog see: .\n" }, { "path": "docs/contributors/fetch.py", "content": "\"\"\"\nGenerate the contributors database.\n\nFIXME: replace `requests` calls with the HTTPie API, when available.\n\"\"\"\nimport json\nimport os\nimport re\nimport sys\nfrom copy import deepcopy\nfrom datetime import datetime\nfrom pathlib import Path\nfrom subprocess import check_output\nfrom time import sleep\nfrom typing import Any, Dict, Optional, Set\n\nimport requests\n\nFullNames = Set[str]\nGitHubLogins = Set[str]\nPerson = Dict[str, str]\nPeople = Dict[str, Person]\nUserInfo = Dict[str, Any]\n\nCO_AUTHORS = re.compile(r'Co-authored-by: ([^<]+) <').finditer\nAPI_URL = 'https://api.github.com'\nREPO = OWNER = 'httpie'\nREPO_URL = f'{API_URL}/repos/{REPO}/{OWNER}'\n\nHERE = Path(__file__).parent\nDB_FILE = HERE / 'people.json'\n\nDEFAULT_PERSON: Person = {'committed': [], 'reported': [], 'github': '', 'twitter': ''}\nSKIPPED_LABELS = {'invalid'}\n\nGITHUB_TOKEN = os.getenv('GITHUB_TOKEN')\nassert GITHUB_TOKEN, 'GITHUB_TOKEN envar is missing'\n\n\nclass FinishedForNow(Exception):\n \"\"\"Raised when remaining GitHub rate limit is zero.\"\"\"\n\n\ndef main(previous_release: str, current_release: str) -> int:\n since = release_date(previous_release)\n until = release_date(current_release)\n\n contributors = load_awesome_people()\n try:\n committers = find_committers(since, until)\n reporters = find_reporters(since, until)\n except Exception as exc:\n # We want to save what we fetched so far. So pass.\n print(' !! ', exc)\n\n try:\n merge_all_the_people(current_release, contributors, committers, reporters)\n fetch_missing_users_details(contributors)\n except FinishedForNow:\n # We want to save what we fetched so far. So pass.\n print(' !! Committers:', committers)\n print(' !! Reporters:', reporters)\n exit_status = 1\n else:\n exit_status = 0\n\n save_awesome_people(contributors)\n return exit_status\n\n\ndef find_committers(since: str, until: str) -> FullNames:\n url = f'{REPO_URL}/commits'\n page = 1\n per_page = 100\n params = {\n 'since': since,\n 'until': until,\n 'per_page': per_page,\n }\n committers: FullNames = set()\n\n while 'there are commits':\n params['page'] = page\n data = fetch(url, params=params)\n\n for item in data:\n commit = item['commit']\n committers.add(commit['author']['name'])\n debug(' >>> Commit', item['html_url'])\n for co_author in CO_AUTHORS(commit['message']):\n name = co_author.group(1)\n committers.add(name)\n\n if len(data) < per_page:\n break\n page += 1\n\n return committers\n\n\ndef find_reporters(since: str, until: str) -> GitHubLogins:\n url = f'{API_URL}/search/issues'\n page = 1\n per_page = 100\n params = {\n 'q': f'repo:{REPO}/{OWNER} is:issue closed:{since}..{until}',\n 'per_page': per_page,\n }\n reporters: GitHubLogins = set()\n\n while 'there are issues':\n params['page'] = page\n data = fetch(url, params=params)\n\n for item in data['items']:\n # Filter out unwanted labels.\n if any(label['name'] in SKIPPED_LABELS for label in item['labels']):\n continue\n debug(' >>> Issue', item['html_url'])\n reporters.add(item['user']['login'])\n\n if len(data['items']) < per_page:\n break\n page += 1\n\n return reporters\n\n\ndef merge_all_the_people(release: str, contributors: People, committers: FullNames, reporters: GitHubLogins) -> None:\n \"\"\"\n >>> contributors = {'Alice': new_person(github='alice', twitter='alice')}\n >>> merge_all_the_people('2.6.0', contributors, {}, {})\n >>> contributors\n {'Alice': {'committed': [], 'reported': [], 'github': 'alice', 'twitter': 'alice'}}\n\n >>> contributors = {'Bob': new_person(github='bob', twitter='bob')}\n >>> merge_all_the_people('2.6.0', contributors, {'Bob'}, {'bob'})\n >>> contributors\n {'Bob': {'committed': ['2.6.0'], 'reported': ['2.6.0'], 'github': 'bob', 'twitter': 'bob'}}\n\n >>> contributors = {'Charlotte': new_person(github='charlotte', twitter='charlotte', committed=['2.5.0'], reported=['2.5.0'])}\n >>> merge_all_the_people('2.6.0', contributors, {'Charlotte'}, {'charlotte'})\n >>> contributors\n {'Charlotte': {'committed': ['2.5.0', '2.6.0'], 'reported': ['2.5.0', '2.6.0'], 'github': 'charlotte', 'twitter': 'charlotte'}}\n\n \"\"\"\n # Update known contributors.\n for name, details in contributors.items():\n if name in committers:\n if release not in details['committed']:\n details['committed'].append(release)\n committers.remove(name)\n if details['github'] in reporters:\n if release not in details['reported']:\n details['reported'].append(release)\n reporters.remove(details['github'])\n\n # Add new committers.\n for name in committers:\n user_info = user(fullname=name)\n contributors[name] = new_person(\n github=user_info['login'],\n twitter=user_info['twitter_username'],\n committed=[release],\n )\n if user_info['login'] in reporters:\n contributors[name]['reported'].append(release)\n reporters.remove(user_info['login'])\n\n # Add new reporters.\n for github_username in reporters:\n user_info = user(github_username=github_username)\n contributors[user_info['name'] or user_info['login']] = new_person(\n github=github_username,\n twitter=user_info['twitter_username'],\n reported=[release],\n )\n\n\ndef release_date(release: str) -> str:\n date = check_output(['git', 'log', '-1', '--format=%ai', release], text=True).strip()\n return datetime.strptime(date, '%Y-%m-%d %H:%M:%S %z').isoformat()\n\n\ndef load_awesome_people() -> People:\n try:\n with DB_FILE.open(encoding='utf-8') as fh:\n return json.load(fh)\n except (FileNotFoundError, ValueError):\n return {}\n\n\ndef fetch(url: str, params: Optional[Dict[str, str]] = None) -> UserInfo:\n headers = {\n 'Accept': 'application/vnd.github.v3+json',\n 'Authentication': f'token {GITHUB_TOKEN}'\n }\n for retry in range(1, 6):\n debug(f'[{retry}/5]', f'{url = }', f'{params = }')\n with requests.get(url, params=params, headers=headers) as req:\n try:\n req.raise_for_status()\n except requests.exceptions.HTTPError as exc:\n if exc.response.status_code == 403:\n # 403 Client Error: rate limit exceeded for url: ...\n now = int(datetime.utcnow().timestamp())\n xrate_limit_reset = int(exc.response.headers['X-RateLimit-Reset'])\n wait = xrate_limit_reset - now\n if wait > 20:\n raise FinishedForNow()\n debug(' !', 'Waiting', wait, 'seconds before another try ...')\n sleep(wait)\n continue\n return req.json()\n assert ValueError('Rate limit exceeded')\n\n\ndef new_person(**kwargs: str) -> Person:\n data = deepcopy(DEFAULT_PERSON)\n data.update(**kwargs)\n return data\n\n\ndef user(fullname: Optional[str] = '', github_username: Optional[str] = '') -> UserInfo:\n if github_username:\n url = f'{API_URL}/users/{github_username}'\n return fetch(url)\n\n url = f'{API_URL}/search/users'\n for query in (f'fullname:{fullname}', f'user:{fullname}'):\n params = {\n 'q': f'repo:{REPO}/{OWNER} {query}',\n 'per_page': 1,\n }\n user_info = fetch(url, params=params)\n if user_info['items']:\n user_url = user_info['items'][0]['url']\n return fetch(user_url)\n\n\ndef fetch_missing_users_details(people: People) -> None:\n for name, details in people.items():\n if details['github'] and details['twitter']:\n continue\n user_info = user(github_username=details['github'], fullname=name)\n if not details['github']:\n details['github'] = user_info['login']\n if not details['twitter']:\n details['twitter'] = user_info['twitter_username']\n\n\ndef save_awesome_people(people: People) -> None:\n with DB_FILE.open(mode='w', encoding='utf-8') as fh:\n json.dump(people, fh, indent=4, sort_keys=True)\n fh.write(\"\\n\")\n\n\ndef debug(*args: Any) -> None:\n if os.getenv('DEBUG') == '1':\n print(*args)\n\n\nif __name__ == '__main__':\n ret = 1\n try:\n ret = main(*sys.argv[1:])\n except TypeError:\n ret = 2\n print(f'''\nFetch contributors to a release.\n\nUsage:\n python {sys.argv[0]} {sys.argv[0]} \nExample:\n python {sys.argv[0]} 2.4.0 2.5.0\n\nDefine the DEBUG=1 environment variable to enable verbose output.\n''')\n except KeyboardInterrupt:\n ret = 255\n sys.exit(ret)\n" }, { "path": "docs/contributors/generate.py", "content": "\"\"\"\nGenerate snippets to copy-paste.\n\"\"\"\nimport sys\n\nfrom jinja2 import Template\n\nfrom fetch import HERE, load_awesome_people\n\nTPL_FILE = HERE / 'snippet.jinja2'\n\nHTTPIE_TEAM = {\n 'claudiatd',\n 'jakubroztocil',\n 'jkbr',\n 'isidentical'\n}\n\nBOT_ACCOUNTS = {\n 'dependabot-sr'\n}\n\nIGNORE_ACCOUNTS = HTTPIE_TEAM | BOT_ACCOUNTS\n\n\ndef generate_snippets(release: str) -> str:\n people = load_awesome_people()\n contributors = {\n name: details\n for name, details in people.items()\n if details['github'] not in IGNORE_ACCOUNTS\n and (release in details['committed'] or release in details['reported'])\n }\n\n template = Template(source=TPL_FILE.read_text(encoding='utf-8'))\n output = template.render(contributors=contributors, release=release)\n print(output)\n return 0\n\n\nif __name__ == '__main__':\n ret = 1\n try:\n ret = generate_snippets(sys.argv[1])\n except (IndexError, TypeError):\n ret = 2\n print(f'''\nGenerate snippets for contributors to a release.\n\nUsage:\n python {sys.argv[0]} {sys.argv[0]} \n''')\n sys.exit(ret)\n" }, { "path": "docs/contributors/people.json", "content": "{\n \"Aaron Miller\": {\n \"committed\": [],\n \"github\": \"aaronhmiller\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": \"aaronmiller8\"\n },\n \"Alexander Bogdanov\": {\n \"committed\": [],\n \"github\": \"ab-kily\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Almad\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"Almad\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": \"almadcz\"\n },\n \"Andr\\u00e1s Czig\\u00e1ny\": {\n \"committed\": [],\n \"github\": \"andrascz\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Annette Wilson\": {\n \"committed\": [],\n \"github\": \"annettejanewilson\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Anton Emelyanov\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"king-menin\",\n \"reported\": [],\n \"twitter\": null\n },\n \"Batuhan Taskaya\": {\n \"committed\": [\n \"3.0.0\",\n \"3.2.0\"\n ],\n \"github\": \"isidentical\",\n \"reported\": [\n \"3.0.0\",\n \"3.2.0\"\n ],\n \"twitter\": \"isidentical\"\n },\n \"Brad Crittenden\": {\n \"committed\": [],\n \"github\": \"bac\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Chad\": {\n \"committed\": [],\n \"github\": \"cythrawll\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"D8ger\": {\n \"committed\": [],\n \"github\": \"caofanCPU\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Dave\": {\n \"committed\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"davecheney\",\n \"reported\": [],\n \"twitter\": \"davecheney\"\n },\n \"Dawid Ferenczy Rogo\\u017ean\": {\n \"committed\": [],\n \"github\": \"ferenczy\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": \"DawidFerenczy\"\n },\n \"Ed Rooth\": {\n \"committed\": [],\n \"github\": \"sym3tri\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Elena Lape\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"elenalape\",\n \"reported\": [],\n \"twitter\": \"elena_lape\"\n },\n \"Ethan Mills\": {\n \"committed\": [\n \"3.2.0\"\n ],\n \"github\": \"ethanmills\",\n \"reported\": [],\n \"twitter\": null\n },\n \"Fabio Peruzzo\": {\n \"committed\": [],\n \"github\": \"peruzzof\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"F\\u00fash\\u0113ng\": {\n \"committed\": [],\n \"github\": \"lienide\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Gabriel Cruz\": {\n \"committed\": [],\n \"github\": \"gmelodie\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": \"gmelodiecruz\"\n },\n \"Gaurav\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"gkcs\",\n \"reported\": [],\n \"twitter\": null\n },\n \"Giampaolo Rodola\": {\n \"committed\": [],\n \"github\": \"giampaolo\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Greg Myers\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"myersg86\",\n \"reported\": [],\n \"twitter\": null\n },\n \"Hugh Williams\": {\n \"committed\": [],\n \"github\": \"hughpv\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Ilya Sukhanov\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"IlyaSukhanov\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Jakub Roztocil\": {\n \"committed\": [\n \"2.5.0\",\n \"2.6.0\",\n \"3.0.0\",\n \"3.2.0\"\n ],\n \"github\": \"jakubroztocil\",\n \"reported\": [\n \"2.5.0\",\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": \"jakubroztocil\"\n },\n \"Jan Bra\\u0161na\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"janbrasna\",\n \"reported\": [],\n \"twitter\": \"janbrasna\"\n },\n \"Jan Verbeek\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"blyxxyz\",\n \"reported\": [\n \"3.0.0\",\n \"3.2.0\"\n ],\n \"twitter\": null\n },\n \"Jannik Vieten\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"exploide\",\n \"reported\": [],\n \"twitter\": null\n },\n \"Jesper Holmberg\": {\n \"committed\": [],\n \"github\": \"strindberg\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Kirill Krasnov\": {\n \"committed\": [],\n \"github\": \"Kirill\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Marcel St\\u00f6r\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"marcelstoer\",\n \"reported\": [],\n \"twitter\": \"frightanic\"\n },\n \"Marco Seguri\": {\n \"committed\": [],\n \"github\": \"seguri\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Mariano Ruiz\": {\n \"committed\": [],\n \"github\": \"mrsarm\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": \"mrsarm82\"\n },\n \"Mark Rosenbaum\": {\n \"committed\": [],\n \"github\": \"markrosenbaum\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Micka\\u00ebl Schoentgen\": {\n \"committed\": [\n \"2.5.0\",\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"BoboTiG\",\n \"reported\": [\n \"2.5.0\",\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": \"__tiger222__\"\n },\n \"Mike DePalatis\": {\n \"committed\": [],\n \"github\": \"mivade\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Miro Hron\\u010dok\": {\n \"committed\": [\n \"2.5.0\",\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"hroncok\",\n \"reported\": [],\n \"twitter\": \"hroncok\"\n },\n \"Mohamed Daahir\": {\n \"committed\": [],\n \"github\": \"ducaale\",\n \"reported\": [\n \"2.5.0\",\n \"3.2.0\"\n ],\n \"twitter\": null\n },\n \"Nanashi.\": {\n \"committed\": [],\n \"github\": \"sevenc-nanashi\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": \"sevenc_nanashi\"\n },\n \"Nicklas Ansman Giertz\": {\n \"committed\": [],\n \"github\": \"ansman\",\n \"reported\": [\n \"3.2.0\"\n ],\n \"twitter\": null\n },\n \"Oliver Fish\": {\n \"committed\": [],\n \"github\": \"Oliver-Fish\",\n \"reported\": [\n \"3.2.0\"\n ],\n \"twitter\": null\n },\n \"Omer Akram\": {\n \"committed\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"om26er\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": \"om26er\"\n },\n \"Patrick Taylor\": {\n \"committed\": [],\n \"github\": \"pmeister\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Paul Laffitte\": {\n \"committed\": [],\n \"github\": \"paullaffitte\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": \"plaffitt\"\n },\n \"Pavel Alexeev aka Pahan-Hubbitus\": {\n \"committed\": [],\n \"github\": \"Hubbitus\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Roberto L\\u00f3pez L\\u00f3pez\": {\n \"committed\": [],\n \"github\": \"robertolopezlopez\",\n \"reported\": [\n \"3.2.0\"\n ],\n \"twitter\": null\n },\n \"Russell Shurts\": {\n \"committed\": [],\n \"github\": \"rshurts\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Samuel Marks\": {\n \"committed\": [],\n \"github\": \"SamuelMarks\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Sebastian Czech\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"sebastianczech\",\n \"reported\": [],\n \"twitter\": \"sebaczech\"\n },\n \"Sullivan SENECHAL\": {\n \"committed\": [],\n \"github\": \"soullivaneuh\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Thomas Klinger\": {\n \"committed\": [],\n \"github\": \"mosesontheweb\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"Vincent van \\u2019t Zand\": {\n \"committed\": [],\n \"github\": \"vovtz\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Vivaan Verma\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"doublevcodes\",\n \"reported\": [],\n \"twitter\": \"doublevcodes\"\n },\n \"Vladimir Berkutov\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"dair-targ\",\n \"reported\": [],\n \"twitter\": null\n },\n \"Will Rogers\": {\n \"committed\": [],\n \"github\": \"wjrogers\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"Yannic Schneider\": {\n \"committed\": [],\n \"github\": \"cynay\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"a1346054\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"a1346054\",\n \"reported\": [],\n \"twitter\": null\n },\n \"arloan\": {\n \"committed\": [],\n \"github\": \"arloan\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"bl-ue\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"FiReBlUe45\",\n \"reported\": [],\n \"twitter\": null\n },\n \"blueray453\": {\n \"committed\": [],\n \"github\": \"blueray453\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"claudiatd\": {\n \"committed\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"claudiatd\",\n \"reported\": [],\n \"twitter\": null\n },\n \"coldcoff\": {\n \"committed\": [],\n \"github\": \"coldcoff\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"dependabot[bot]\": {\n \"committed\": [\n \"3.2.0\"\n ],\n \"github\": \"dependabot-sr\",\n \"reported\": [],\n \"twitter\": null\n },\n \"dkreeft\": {\n \"committed\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"dkreeft\",\n \"reported\": [],\n \"twitter\": null\n },\n \"greg\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"gregkh\",\n \"reported\": [],\n \"twitter\": null\n },\n \"henryhu712\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"henryhu712\",\n \"reported\": [],\n \"twitter\": null\n },\n \"hosseingt\": {\n \"committed\": [\n \"3.0.0\"\n ],\n \"github\": \"hosseingt\",\n \"reported\": [],\n \"twitter\": null\n },\n \"jakubroztocil\": {\n \"committed\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"github\": \"jkbr\",\n \"reported\": [],\n \"twitter\": null\n },\n \"josephworks\": {\n \"committed\": [],\n \"github\": \"josephworks\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"jungle-boogie\": {\n \"committed\": [],\n \"github\": \"jungle-boogie\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"luisuimi\": {\n \"committed\": [],\n \"github\": \"luisuimi\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"luzpaz\": {\n \"committed\": [\n \"3.2.0\"\n ],\n \"github\": \"luzpaz\",\n \"reported\": [],\n \"twitter\": null\n },\n \"nixbytes\": {\n \"committed\": [\n \"2.5.0\"\n ],\n \"github\": \"nixbytes\",\n \"reported\": [],\n \"twitter\": \"linuxbyte3\"\n },\n \"peterpt\": {\n \"committed\": [],\n \"github\": \"peterpt\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"qiulang\": {\n \"committed\": [],\n \"github\": \"qiulang\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"stonebig\": {\n \"committed\": [],\n \"github\": \"stonebig\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"whodidthis\": {\n \"committed\": [],\n \"github\": \"whodidthis\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"zhaohanqing95\": {\n \"committed\": [],\n \"github\": \"zhaohanqing95\",\n \"reported\": [\n \"3.2.0\"\n ],\n \"twitter\": null\n },\n \"zoulja\": {\n \"committed\": [],\n \"github\": \"zoulja\",\n \"reported\": [\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"zwx00\": {\n \"committed\": [],\n \"github\": \"zwx00\",\n \"reported\": [\n \"2.5.0\"\n ],\n \"twitter\": null\n },\n \"\\u5d14\\u5c0f\\u4e8c\": {\n \"committed\": [],\n \"github\": \"rogerdehe\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": null\n },\n \"\\u9ec4\\u6d77\": {\n \"committed\": [],\n \"github\": \"hh-in-zhuzhou\",\n \"reported\": [\n \"2.6.0\",\n \"3.0.0\"\n ],\n \"twitter\": null\n }\n}\n" }, { "path": "docs/contributors/snippet.jinja2", "content": "\n\n## Community contributions\n\nWe’d like to thank these amazing people for their contributions to this release:\n{% for name, details in contributors.items() -%}\n- [{{ name }}](https://github.com/{{ details.github }}){{ '' if loop.last else '\\n' }}\n{%- endfor %}\n\n\n\nWe’d like to thank these amazing people for their contributions to HTTPie {{ release }}: {% for name, details in contributors.items() if details.twitter -%}\n @{{ details.twitter }}{{ '' if loop.last else ', ' }}\n{%- endfor %} 🥧\n" }, { "path": "docs/installation/README.md", "content": "Here we maintain a database of installation methods, from which we generate\nthe installation section in docs. If you’d like add or update an installation method,\nedit [methods.yml](./methods.yml), do not edit the main docs directly.\n\nFor HTTPie installation instructions see: .\n" }, { "path": "docs/installation/generate.py", "content": "import re\nimport sys\nfrom pathlib import Path\nfrom typing import Dict\n\nimport yaml\nfrom jinja2 import Template\n\nDatabase = Dict[str, dict]\n\n# Files\nHERE = Path(__file__).parent\nDB_FILE = HERE / 'methods.yml'\nDOC_FILE = HERE.parent / 'README.md'\nTPL_FILE = HERE / 'installation.jinja2'\n\n# Database keys\nKEY_DOC_STRUCTURE = 'docs-structure'\nKEY_TOOLS = 'tools'\n\n# Markers in-between content will be put.\nMARKER_START = '
'\nMARKER_END = '
'\n\n\ndef generate_documentation() -> str:\n database = load_database()\n structure = build_docs_structure(database)\n template = Template(source=TPL_FILE.read_text(encoding='utf-8'))\n output = template.render(structure=structure)\n output = clean_template_output(output)\n return output\n\n\ndef save_doc_file(content: str) -> None:\n current_doc = load_doc_file()\n marker_start = current_doc.find(MARKER_START) + len(MARKER_START)\n assert marker_start > 0, 'cannot find the start marker'\n marker_end = current_doc.find(MARKER_END, marker_start)\n assert marker_start < marker_end, f'{marker_end=} < {marker_start=}'\n updated_doc = (\n current_doc[:marker_start]\n + '\\n\\n'\n + content\n + '\\n\\n'\n + current_doc[marker_end:]\n )\n if current_doc != updated_doc:\n DOC_FILE.write_text(updated_doc, encoding='utf-8')\n\n\ndef build_docs_structure(database: Database):\n tools = database[KEY_TOOLS]\n assert len(tools) == len({tool['title'] for tool in tools.values()}), 'tool titles need to be unique'\n tree = database[KEY_DOC_STRUCTURE]\n structure = []\n for platform, tools_ids in tree.items():\n assert platform.isalnum(), f'{platform=} must be alphanumeric for generated links to work'\n platform_tools = [tools[tool_id] for tool_id in tools_ids]\n structure.append((platform, platform_tools))\n return structure\n\n\ndef clean_template_output(output):\n output = '\\n'.join(line.strip() for line in output.strip().splitlines())\n output = re.sub('\\n{3,}', '\\n\\n', output)\n return output\n\n\ndef load_database() -> Database:\n return yaml.safe_load(DB_FILE.read_text(encoding='utf-8'))\n\n\ndef load_doc_file() -> str:\n return DOC_FILE.read_text(encoding='utf-8')\n\n\ndef main() -> int:\n content = generate_documentation()\n save_doc_file(content)\n return 0\n\n\nif __name__ == '__main__':\n sys.exit(main())\n" }, { "path": "docs/installation/installation.jinja2", "content": "\n{% for platform, tools in structure %}\n - [{{ platform }}](#{{ platform.lower() }}){% endfor %} {# <= keep `endfor` here to prevent unwanted `\\n` #}\n\n{% for platform, tools in structure %}\n\n ### {{ platform }}\n\n {% for tool in tools %}\n #### {{ tool.title }}\n\n {% if tool.note %}\n {{ tool.note }}\n {% endif %}\n\n {% if tool.links.setup %}\n To install [{{ tool.name }}]({{ tool.links.homepage }}), see [its installation]({{ tool.links.setup }}).\n {% endif %}\n\n ```bash\n # Install httpie\n $ {{ tool.commands.install|join('\\n$ ') }}\n ```\n\n ```bash\n # Upgrade httpie\n $ {{ tool.commands.upgrade|join('\\n$ ') }}\n ```\n {% endfor %}\n\n{% endfor %}\n\n" }, { "path": "docs/installation/methods.yml", "content": "# Database of HTTPie installation methods. Used to build the docs.\n#\n# We currently only include here methods for popular systems where we take care of the package,\n# or have a good relationship with the maintainers.\n#\n# Each tool name should be unique (it becomes a linkable header).\n# If a tools have `links.setup`, it also needs `links.homepage`.\n# Some tools are available on multiple platforms, take into account when editing.\n#\n\ndocs-structure:\n Universal:\n - pypi\n macOS:\n - brew-mac\n - port\n Windows:\n - chocolatey\n Linux:\n - apt\n - dnf\n - yum\n - single-binary\n - snap-linux\n - brew-linux\n - pacman\n FreeBSD:\n - pkg\n\ntools:\n apt:\n title: Debian and Ubuntu\n note: Also works for other Debian-derived distributions like MX Linux, Linux Mint, deepin, Pop!_OS, KDE neon, Zorin OS, elementary OS, Kubuntu, Devuan, Linux Lite, Peppermint OS, Lubuntu, antiX, Xubuntu, etc.\n name: APT\n links:\n homepage: https://en.wikipedia.org/wiki/APT_(software)\n package: https://packages.debian.org/sid/web/httpie\n commands:\n install:\n - curl -SsL https://packages.httpie.io/deb/KEY.gpg | sudo gpg --dearmor -o /usr/share/keyrings/httpie.gpg\n # - curl -SsL -o /etc/apt/sources.list.d/httpie.list https://packages.httpie.io/deb/httpie.list\n - echo \"deb [arch=amd64 signed-by=/usr/share/keyrings/httpie.gpg] https://packages.httpie.io/deb ./\" | sudo tee /etc/apt/sources.list.d/httpie.list > /dev/null\n - sudo apt update\n - sudo apt install httpie\n upgrade:\n - sudo apt update && sudo apt upgrade httpie\n\n brew-mac:\n title: Homebrew\n name: Homebrew\n links:\n homepage: https://brew.sh/\n setup: https://docs.brew.sh/Installation\n package: https://formulae.brew.sh/formula/httpie\n commands:\n install:\n - brew update\n - brew install httpie\n upgrade:\n - brew update\n - brew upgrade httpie\n\n brew-linux:\n title: Linuxbrew\n name: Linuxbrew\n links:\n homepage: https://docs.brew.sh/Homebrew-on-Linux\n setup: https://docs.brew.sh/Homebrew-on-Linux#install\n package: https://formulae.brew.sh/formula/httpie\n commands:\n install:\n - brew update\n - brew install httpie\n upgrade:\n - brew update\n - brew upgrade httpie\n\n chocolatey:\n title: Chocolatey\n name: Chocolatey\n links:\n homepage: https://chocolatey.org/\n setup: https://chocolatey.org/install\n package: https://community.chocolatey.org/packages/httpie/\n commands:\n install:\n - choco install httpie\n upgrade:\n - choco upgrade httpie\n\n dnf:\n title: Fedora\n name: DNF\n links:\n homepage: https://fedoraproject.org/wiki/DNF\n package: https://src.fedoraproject.org/rpms/httpie\n commands:\n install:\n - dnf install httpie\n upgrade:\n - dnf upgrade httpie\n\n pacman:\n title: Arch Linux\n name: pacman\n note: Also works for other Arch-derived distributions like ArcoLinux, EndeavourOS, Artix Linux, etc.\n links:\n homepage: https://archlinux.org/pacman/\n package: https://archlinux.org/packages/community/any/httpie/\n commands:\n install:\n - pacman -Syu httpie\n upgrade:\n - pacman -Syu\n\n pkg:\n title: FreshPorts\n name: FreshPorts\n links:\n homepage: https://www.freebsd.org/cgi/man.cgi?query=pkg&sektion=8&n=1\n package: https://www.freshports.org/www/py-httpie/\n commands:\n install:\n - pkg install www/py-httpie\n upgrade:\n - pkg upgrade www/py-httpie\n\n port:\n title: MacPorts\n name: MacPorts\n links:\n homepage: https://www.macports.org/\n setup: https://www.macports.org/install.php\n package: https://ports.macports.org/port/httpie/\n commands:\n install:\n - port selfupdate\n - port install httpie\n upgrade:\n - port selfupdate\n - port upgrade httpie\n\n pypi:\n title: PyPI\n name: pip\n note: Please make sure you have Python 3.7 or newer (`python --version`).\n links:\n homepage: https://pypi.org/\n # setup: https://pip.pypa.io/en/stable/installation/\n package: https://pypi.org/project/httpie/\n commands:\n install:\n - python -m pip install --upgrade pip wheel\n - python -m pip install httpie\n upgrade:\n - python -m pip install --upgrade pip wheel\n - python -m pip install --upgrade httpie\n\n snap-linux:\n title: Snapcraft (Linux)\n name: Snapcraft\n links:\n homepage: https://snapcraft.io/\n setup: https://snapcraft.io/docs/installing-snapd\n package: https://snapcraft.io/httpie\n commands:\n install:\n - snap install httpie\n upgrade:\n - snap refresh httpie\n\n yum:\n title: CentOS and RHEL\n name: Yum\n note: Also works for other RHEL-derived distributions like ClearOS, Oracle Linux, etc.\n links:\n homepage: http://yum.baseurl.org/\n package: https://src.fedoraproject.org/rpms/httpie\n commands:\n install:\n - yum install epel-release\n - yum install httpie\n upgrade:\n - yum upgrade httpie\n\n single-binary:\n title: Single binary executables\n name: Single binary executables\n note: Get the standalone HTTPie Linux executables when you don't want to go through the full installation process.\n links:\n commands:\n install:\n - https --download packages.httpie.io/binaries/linux/http-latest -o http\n - ln -ls ./http ./https\n - chmod +x ./http ./https\n upgrade:\n - https --download packages.httpie.io/binaries/linux/http-latest -o http\n" }, { "path": "docs/markdownlint.rb", "content": "# Rules for \n\n# Load all rules by default\nall\n\n#\n# Tweak rules\n#\n\n# MD002 First header should be a top level header\n# Because we use HTML to hide them on the website.\nexclude_rule 'MD002'\n\n# MD007 Allow unordered list indentation\nexclude_rule 'MD007'\n\n# MD013 Line length\nexclude_rule 'MD013'\n\n# MD014 Dollar signs used before commands without showing output\nexclude_rule 'MD014'\n\n# MD028 Blank line inside blockquote\nexclude_rule 'MD028'\n\n# MD012 Multiple consecutive blank lines\nexclude_rule 'MD012'\n\n# Tell the linter to use ordered lists:\n# 1. Foo\n# 2. Bar\n# 3. Baz\n#\n# Instead of:\n# 1. Foo\n# 1. Bar\n# 1. Baz\nrule 'MD029', :style => :ordered\n\n# MD033 Inline HTML\n# TODO: Tweak elements when https://github.com/markdownlint/markdownlint/issues/118 will be done?\nexclude_rule 'MD033'\n\n# MD034 Bare URL used\n# TODO: Remove when https://github.com/markdownlint/markdownlint/issues/328 will be fixed.\nexclude_rule 'MD034'\n\n# MD041 First line in file should be a top level header\n# Because we use HTML to hide them on the website.\nexclude_rule 'MD041'\n" }, { "path": "docs/packaging/README.md", "content": "# HTTPie release process\n\nWelcome on the documentation part of the **HTTPie release process**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions, then you can find all you need for your OS on [that page](https://httpie.io/docs#installation). In the case you do not find your OS, [let us know](https://github.com/httpie/cli/issues/).\n- If you are looking for technical information about the HTTPie packaging, then you are at the good place.\n\n## About\n\nYou are looking at the HTTPie packaging documentation, where you will find valuable information about how we manage to release HTTPie to lots of OSes, including technical data that may be worth reading if you are a package maintainer.\n\nThe overall release process starts simple:\n\n1. Bump the version identifiers in the following places:\n - `httpie/__init__.py`\n - `docs/packaging/windows-chocolatey/httpie.nuspec`\n - `CHANGELOG.md`\n2. Commit your changes and make a PR against the `master`.\n3. Merge the PR, and tag the last commit with your version identifier.\n4. Make a GitHub release (by copying the text in `CHANGELOG.md`)\n5. Push that release to PyPI (dispatch the `Release PyPI` GitHub action).\n6. Once PyPI is ready, push the release to the Snap, Homebrew and Chocolatey with their respective actions.\n7. Go to the [`httpie/debian.httpie.io`](https://github.com/httpie/debian.httpie.io) repo and trigger the package index workflow.\n\n## Company-specific tasks\n\n- Blank the `master_and_released_docs_differ_after` value in [config.json](https://github.com/httpie/cli/blob/master/docs/config.json).\n- Update the [contributors list](../contributors).\n- Update the HTTPie version bundled into [Termible](https://termible.io/) ([example](https://github.com/httpie/termible/pull/1)).\n\n## Finally, spread dowstream\n\nFind out how we do release new versions for each and every supported OS in the following table.\nA more complete state of deployment can be found on [repology](https://repology.org/project/httpie/versions), including unofficial packages.\n\n| OS | Maintainer |\n| -------------------------------------------: | -------------- |\n| [Arch Linux, and derived](linux-arch/) | trusted person |\n| [CentOS, RHEL, and derived](linux-centos/) | trusted person |\n| [Fedora](linux-fedora/) | trusted person |\n| [Debian, Ubuntu, and derived](linux-debian/) | **HTTPie** |\n| [Homebrew, Linuxbrew](brew/) | **HTTPie** |\n| [Snapcraft](snapcraft/) | **HTTPie** |\n| [Windows — Chocolatey](windows-chocolatey/) | **HTTPie** |\n\n:new: You do not find your system or you would like to see HTTPie supported on another OS? Then [let us know](https://github.com/httpie/cli/issues/).\n" }, { "path": "docs/packaging/brew/README.md", "content": "# HTTPie on Homebrew, and Linuxbrew\n\nWelcome to the documentation about **packaging HTTPie for Homebrew**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on Homebrew, then you can find them on [that page](https://httpie.io/docs#homebrew) ([that one](https://httpie.io/docs#linuxbrew) for Linuxbrew).\n- If you are looking for technical information about the HTTPie packaging on Homebrew, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for Homebrew. They apply to Linuxbrew as well.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\n## Overall process\n\nThe brew deployment is completely automated, and only requires a trigger to [`Release on Homebrew`](https://github.com/httpie/cli/actions/workflows/release-brew.yml) action\nfrom the release manager.\n\nIf it is needed to be done manually, the following command can be used:\n\n```console\n$ brew bump-formula-pr httpie --version={TARGET_VERSION}\n```\n\nwhich will bump the formula, and create a PR against the package index.\n\n## Hacking\n\nMake your changes, test the formula through the [`Test Brew Package`](https://github.com/httpie/cli/actions/workflows/test-package-mac-brew.yml) action\nand then finally submit your patch to [`homebrew-core`](https://github.com/Homebrew/homebrew-core`)\n\n" }, { "path": "docs/packaging/brew/httpie.rb", "content": "class Httpie < Formula\n include Language::Python::Virtualenv\n\n desc \"User-friendly cURL replacement (command-line HTTP client)\"\n homepage \"https://httpie.io/\"\n url \"https://files.pythonhosted.org/packages/32/85/bb095699be20cc98731261cb80884e9458178f8fef2a38273530ce77c0a5/httpie-3.1.0.tar.gz\"\n sha256 \"2e4a2040b84a912e65c01fb34f7aafe88cad2a3af2da8c685ca65080f376feda\"\n license \"BSD-3-Clause\"\n head \"https://github.com/httpie/cli.git\", branch: \"master\"\n\n bottle do\n sha256 cellar: :any_skip_relocation, arm64_monterey: \"9bb6e8c1ef5ba8b019ddedd7e908dd2174da695351aa9a238dfb28b0f57ef005\"\n sha256 cellar: :any_skip_relocation, arm64_big_sur: \"47ffccd3241155d863e1b4f6259d538a34d42a0cdeed8152bda257ee607b51be\"\n sha256 cellar: :any_skip_relocation, monterey: \"dc4a04cb05a9cd1bfa6a632a0e4a21975905954af54ece41f9050c52474267be\"\n sha256 cellar: :any_skip_relocation, big_sur: \"ae469e37864e967e0fd99fba15a78e719dcb351b462f98f3843c78ed1473df6d\"\n sha256 cellar: :any_skip_relocation, catalina: \"291a3eaecb2a2cc845c1652686a9a14b21053d7e3a7d0115245b2150ca2e199e\"\n sha256 cellar: :any_skip_relocation, x86_64_linux: \"710836e27c44c8e3ad181d668f4a9f78c4cb4c355d7b148a397599a7cd42713d\"\n end\n\n depends_on \"python@3.10\"\n\n resource \"certifi\" do\n url \"https://files.pythonhosted.org/packages/6c/ae/d26450834f0acc9e3d1f74508da6df1551ceab6c2ce0766a593362d6d57f/certifi-2021.10.8.tar.gz\"\n sha256 \"78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872\"\n end\n\n resource \"charset-normalizer\" do\n url \"https://files.pythonhosted.org/packages/56/31/7bcaf657fafb3c6db8c787a865434290b726653c912085fbd371e9b92e1c/charset-normalizer-2.0.12.tar.gz\"\n sha256 \"2857e29ff0d34db842cd7ca3230549d1a697f96ee6d3fb071cfa6c7393832597\"\n end\n\n resource \"defusedxml\" do\n url \"https://files.pythonhosted.org/packages/0f/d5/c66da9b79e5bdb124974bfe172b4daf3c984ebd9c2a06e2b8a4dc7331c72/defusedxml-0.7.1.tar.gz\"\n sha256 \"1bb3032db185915b62d7c6209c5a8792be6a32ab2fedacc84e01b52c51aa3e69\"\n end\n\n resource \"idna\" do\n url \"https://files.pythonhosted.org/packages/62/08/e3fc7c8161090f742f504f40b1bccbfc544d4a4e09eb774bf40aafce5436/idna-3.3.tar.gz\"\n sha256 \"9d643ff0a55b762d5cdb124b8eaa99c66322e2157b69160bc32796e824360e6d\"\n end\n\n resource \"multidict\" do\n url \"https://files.pythonhosted.org/packages/fa/a7/71c253cdb8a1528802bac7503bf82fe674367e4055b09c28846fdfa4ab90/multidict-6.0.2.tar.gz\"\n sha256 \"5ff3bd75f38e4c43f1f470f2df7a4d430b821c4ce22be384e1459cb57d6bb013\"\n end\n\n resource \"Pygments\" do\n url \"https://files.pythonhosted.org/packages/94/9c/cb656d06950268155f46d4f6ce25d7ffc51a0da47eadf1b164bbf23b718b/Pygments-2.11.2.tar.gz\"\n sha256 \"4e426f72023d88d03b2fa258de560726ce890ff3b630f88c21cbb8b2503b8c6a\"\n end\n\n resource \"PySocks\" do\n url \"https://files.pythonhosted.org/packages/bd/11/293dd436aea955d45fc4e8a35b6ae7270f5b8e00b53cf6c024c83b657a11/PySocks-1.7.1.tar.gz\"\n sha256 \"3f8804571ebe159c380ac6de37643bb4685970655d3bba243530d6558b799aa0\"\n end\n\n resource \"requests\" do\n url \"https://files.pythonhosted.org/packages/60/f3/26ff3767f099b73e0efa138a9998da67890793bfa475d8278f84a30fec77/requests-2.27.1.tar.gz\"\n sha256 \"68d7c56fd5a8999887728ef304a6d12edc7be74f1cfa47714fc8b414525c9a61\"\n end\n\n resource \"requests-toolbelt\" do\n url \"https://files.pythonhosted.org/packages/28/30/7bf7e5071081f761766d46820e52f4b16c8a08fef02d2eb4682ca7534310/requests-toolbelt-0.9.1.tar.gz\"\n sha256 \"968089d4584ad4ad7c171454f0a5c6dac23971e9472521ea3b6d49d610aa6fc0\"\n end\n\n resource \"urllib3\" do\n url \"https://files.pythonhosted.org/packages/b0/b1/7bbf5181f8e3258efae31702f5eab87d8a74a72a0aa78bc8c08c1466e243/urllib3-1.26.8.tar.gz\"\n sha256 \"0e7c33d9a63e7ddfcb86780aac87befc2fbddf46c58dbb487e0855f7ceec283c\"\n end\n\n def install\n virtualenv_install_with_resources\n end\n\n test do\n assert_match version.to_s, shell_output(\"#{bin}/httpie --version\")\n assert_match version.to_s, shell_output(\"#{bin}/https --version\")\n assert_match version.to_s, shell_output(\"#{bin}/http --version\")\n\n raw_url = \"https://raw.githubusercontent.com/Homebrew/homebrew-core/HEAD/Formula/httpie.rb\"\n assert_match \"PYTHONPATH\", shell_output(\"#{bin}/http --ignore-stdin #{raw_url}\")\n end\nend\n" }, { "path": "docs/packaging/brew/update.sh", "content": "#!/bin/bash\n\nset -xe\n\nrm -f httpie.rb\nhttp --download https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/httpie.rb\n" }, { "path": "docs/packaging/linux-arch/PKGBUILD", "content": "# Maintainer: Jelle van der Waa \n# Maintainer: daurnimator \n# Contributor: Daniel Micay \n# Contributor: Thomas Weißschuh \n\npkgname=httpie\npkgver=2.6.0\npkgrel=1\npkgdesc=\"human-friendly CLI HTTP client for the API era\"\nurl=\"https://github.com/httpie/cli\"\ndepends=('python-defusedxml'\n 'python-pygments'\n 'python-pysocks'\n 'python-requests'\n 'python-requests-toolbelt'\n 'python-charset-normalizer')\nmakedepends=('python-setuptools')\ncheckdepends=('python-pytest'\n 'python-pytest-httpbin'\n 'python-responses')\nconflicts=(python-httpie)\nreplaces=(python-httpie python2-httpie)\nlicense=('BSD')\narch=('any')\nsource=($pkgname-$pkgver.tar.gz::\"https://github.com/httpie/cli/archive/$pkgver.tar.gz\")\nsha256sums=('3bcd9a8cb2b11299da12d3af36c095c6d4b665e41c395898a07f1ae4d99fc14a')\n\nbuild() {\n cd $pkgname-$pkgver\n python3 setup.py build\n}\n\npackage() {\n cd $pkgname-$pkgver\n install -Dm644 LICENSE \"$pkgdir/usr/share/licenses/httpie/LICENSE\"\n python3 setup.py install --root=\"$pkgdir\" --optimize=1\n\n # Fix upstream, include them in MANIFEST.in and use data_files in setup.py to install them automatically\n # TODO: add zsh support\n install -Dm644 extras/httpie-completion.bash \"$pkgdir\"/usr/share/bash-completion/completions/http\n install -Dm644 extras/httpie-completion.fish \"$pkgdir\"/usr/share/fish/vendor_completions.d/http.fish\n}\n\ncheck() {\n cd $pkgname-$pkgver\n PYTHONDONTWRITEBYTECODE=1 pytest tests\n}\n" }, { "path": "docs/packaging/linux-arch/README.md", "content": "# HTTPie on Arch Linux, and derived\n\nWelcome to the documentation about **packaging HTTPie for Arch Linux**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on Arch Linux, then you can find them on [that page](https://httpie.io/docs#arch-linux).\n- If you are looking for technical information about the HTTPie packaging on Arch Linux, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for Arch Linux. They apply to Arch-derived distributions as well, like ArcoLinux, EndeavourOS, Artix Linux, etc.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\n## Overall process\n\nNote: Sending patches downstream does not seem easy. We failed to find where is located the package file on . So we are relying on the last maintainer, daurnimator, and it works pretty well so far.\n\nCheck and if the version is outdated, simply [report it](https://archlinux.org/packages/community/any/httpie/flag/).\n\n## Hacking\n\nLeft blank on purpose, we will fill that section when we will have access to the downstream repository.\n" }, { "path": "docs/packaging/linux-centos/README.md", "content": "# HTTPie on CentOS, RHEL, and derived\n\nWelcome to the documentation about **packaging HTTPie for CentOS and RHEL**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on CentOS, then you can find them on [that page](https://httpie.io/docs#centos-and-rhel).\n- If you are looking for technical information about the HTTPie packaging on CentOS, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for CentOS. They apply to RHEL as well, and any RHEL-derived distributions like ClearOS, Oracle Linux, etc.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\nThe current maintainer is [Mikel Olasagasti](https://github.com/kaxero).\n\n## Overall process\n\nSame as [Fedora](../linux-fedora/README.md#overall-process).\n\n## Q/A with Mikel\n\nQ: What should we do to help seeing a new version on CentOS?\n\nA: When a new release is published Miro and I get notified by [release-monitoring](https://release-monitoring.org/project/1337/), that fills a BugZilla ticket reporting a new version being available.\n\nThe system also tries to create a simple patch to update the spec file, but in the case of CentOS it needs some manual revision. For example for 2.5.0 `defuxedxml` dep is required. Maybe with CentOS-9 and some new macros that are available now in Fedora it can be automated same way. But even the bump can be automated, maintainers should check for license changes, new binaries/docs/ and so on.\n" }, { "path": "docs/packaging/linux-debian/README.md", "content": "# HTTPie on Debian, Ubuntu, and derived\n\nWelcome to the documentation about **packaging HTTPie for Debian GNU/Linux**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on Debian GNU/Linux, then you can find them on [that page](https://httpie.io/docs#debian-and-ubuntu).\n- If you are looking for technical information about the HTTPie packaging on Debian GNU/Linux, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for Debian GNU/Linux. They apply to Ubuntu as well, and any Debian-derived distributions like MX Linux, Linux Mint, deepin, Pop!_OS, KDE neon, Zorin OS, elementary OS, Kubuntu, Devuan, Linux Lite, Peppermint OS, Lubuntu, antiX, Xubuntu, etc.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\nWe create the standalone binaries (see this [for more details](../../../extras/packaging/linux/)) and package them with\n[FPM](https://github.com/jordansissel/fpm)'s `dir` mode. The core `http`/`https` commands don't have any dependencies, but the `httpie`\ncommand (due to the underlying `httpie cli plugins` interface) explicitly depends to the system Python (through `python3`/`python3-pip`).\n\n## Overall process\n\nThe [`Release as Standalone Linux Binary`](https://github.com/httpie/cli/actions/workflows/release-linux-standalone.yml) will be automatically\ntriggered when a new release is created, and it will submit the `.deb` package as a release asset.\n\nFor making that asset available for all debian users, the release manager needs to go to the [`httpie/debian.httpie.io`](https://github.com/httpie/debian.httpie.io) repo\nand trigger the [`Update Index`](https://github.com/httpie/debian.httpie.io/actions/workflows/update-index.yml) action. It will automatically\nscrape all new debian packages from the release assets, properly update the indexes and create a new PR ([an example](https://github.com/httpie/debian.httpie.io/pull/1))\nwhich then will become active when merged.\n" }, { "path": "docs/packaging/linux-fedora/README.md", "content": "# HTTPie on Fedora\n\nWelcome to the documentation about **packaging HTTPie for Fedora**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on Fedora, then you can find them on [that page](https://httpie.io/docs#fedora).\n- If you are looking for technical information about the HTTPie packaging on Fedora, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for Fedora.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\nThe current maintainer is [Miro Hrončok](https://github.com/hroncok).\n\n## Overall process\n\nWe added the [.packit.yaml](https://github.com/httpie/cli/blob/master/.packit.yaml) local file.\nIt unlocks real-time Fedora checks on pull requests and new releases.\n\nSo there is nothing to do on our side: `Packit` will see the new release and open a pull request [there](https://src.fedoraproject.org/rpms/httpie). Then, the Fedora maintainer will review and merge.\n\nIt is also possible to follow [user feedbacks](https://bodhi.fedoraproject.org/updates/?packages=httpie) for all builds.\n\n## Q/A with Miro\n\nQ: What would the command to install the latest stable version look like?\n\nA: Assuming the latest stable version is already propagated to Fedora:\n\n```bash\n# Note that yum is an alias to dnf.\n$ sudo dnf install httpie\n```\n\nQ: Will dnf/yum upgrade then update to the latest?\n\nA: Yes, assuming the same as above.\n\nQ: Are new versions backported automatically?\n\nA: No. The process is:\n\n1. A new HTTPie release is created on Github.\n2. A pull request for Fedora `rawhide` (the development version of Fedora, currently Fedora 36) is created.\n3. A Fedora packager (usually Miro) sanity checks the pull request and merges, builds. HTTPie is updated in `rawhide` within 24 hours (sometimes more, for unrelated issues).\n4. A Fedora packager decides whether the upgrade is suitable for stable Fedora releases (currently 35, 34, 33), if so, merges the changes there.\n5. (if the above is yes) The new version of HTTPie lands in `updates-testing` repo where it waits for user feedback and lands within ~1 week for broad availability.\n" }, { "path": "docs/packaging/linux-fedora/httpie.spec.txt", "content": "Name: httpie\nVersion: 3.1.0\nRelease: 1%{?dist}\nSummary: A Curl-like tool for humans\n\nLicense: BSD\nURL: https://httpie.org/\nSource0: https://github.com/httpie/cli/archive/%{version}/%{name}-%{version}.tar.gz\n\nBuildArch: noarch\n\nBuildRequires: python3-devel\nBuildRequires: pyproject-rpm-macros\n\nBuildRequires: help2man\n\n%description\nHTTPie is a CLI HTTP utility built out of frustration with existing tools. The\ngoal is to make CLI interaction with HTTP-based services as human-friendly as\npossible.\n\nHTTPie does so by providing an http command that allows for issuing arbitrary\nHTTP requests using a simple and natural syntax and displaying colorized\nresponses.\n\n\n%prep\n%autosetup -p1\n\n\n%generate_buildrequires\n%pyproject_buildrequires -rx test\n\n\n%build\n%pyproject_wheel\n\n\n%install\n%pyproject_install\n%pyproject_save_files httpie\n\n# Bash completion\nmkdir -p %{buildroot}%{_datadir}/bash-completion/completions\ncp -a extras/httpie-completion.bash %{buildroot}%{_datadir}/bash-completion/completions/http\nln -s ./http %{buildroot}%{_datadir}/bash-completion/completions/https\n\n# Fish completion\nmkdir -p %{buildroot}%{_datadir}/fish/vendor_completions.d/\ncp -a extras/httpie-completion.fish %{buildroot}%{_datadir}/fish/vendor_completions.d/http.fish\nln -s ./http.fish %{buildroot}%{_datadir}/fish/vendor_completions.d/https.fish\n\n\n# Generate man pages for everything\nexport PYTHONPATH=%{buildroot}%{python3_sitelib}\nmkdir -p %{buildroot}%{_mandir}/man1\nhelp2man %{buildroot}%{_bindir}/http > %{buildroot}%{_mandir}/man1/http.1\nhelp2man %{buildroot}%{_bindir}/https > %{buildroot}%{_mandir}/man1/https.1\nhelp2man %{buildroot}%{_bindir}/httpie > %{buildroot}%{_mandir}/man1/httpie.1\n\n\n%check\n%pytest -v\n\n\n%files -f %{pyproject_files}\n%doc README.md\n%license LICENSE\n%{_bindir}/http\n%{_bindir}/https\n%{_bindir}/httpie\n%{_mandir}/man1/http.1*\n%{_mandir}/man1/https.1*\n%{_mandir}/man1/httpie.1*\n# we co-own the entire directory structures for bash/fish completion to avoid a dependency\n%{_datadir}/bash-completion/\n%{_datadir}/fish/\n\n\n%changelog\n* Tue Mar 08 2022 Miro Hrončok - 3.1.0-1\n- Update to 3.1.0\n- Fixes: rhbz#2061597\n\n* Mon Jan 24 2022 Miro Hrončok - 3.0.2-1\n- Update to 3.0.2\n- Fixes: rhbz#2044572\n\n* Mon Jan 24 2022 Miro Hrončok - 3.0.1-1\n- Update to 3.0.1\n- Fixes: rhbz#2044058\n\n* Fri Jan 21 2022 Miro Hrončok - 3.0.0-1\n- Update to 3.0.0\n- Fixes: rhbz#2043680\n\n* Thu Jan 20 2022 Fedora Release Engineering - 2.6.0-2\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_36_Mass_Rebuild\n\n* Fri Oct 15 2021 Miro Hrončok - 2.6.0-1\n- Update to 2.6.0\n- Fixes: rhbz#2014022\n\n* Tue Sep 07 2021 Miro Hrončok - 2.5.0-1\n- Update to 2.5.0\n- Fixes: rhbz#2001693\n\n* Thu Jul 22 2021 Fedora Release Engineering - 2.4.0-4\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_35_Mass_Rebuild\n\n* Fri Jun 04 2021 Python Maint - 2.4.0-3\n- Rebuilt for Python 3.10\n\n* Thu May 27 2021 Miro Hrončok - 2.4.0-2\n- Add Bash and Fish completion\n- Fixes rhbz#1834441\n- Run tests on build time\n\n* Wed Mar 24 2021 Mikel Olasagasti Uranga - 2.4.0-1\n- Update to 2.4.0\n- Use pypi_source macro\n\n* Tue Jan 26 2021 Fedora Release Engineering - 2.3.0-3\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_34_Mass_Rebuild\n\n* Thu Jan 21 2021 Nils Philippsen - 2.3.0-2\n- use macros for Python dependencies\n- add missing Python dependencies needed for running help2man\n- remove manual Python dependencies\n- discard stderr when running help2man\n\n* Thu Dec 24 2020 Nils Philippsen - 2.3.0-1\n- version 2.3.0\n- Python 2 is no more\n- use %%autosetup and Python build macros\n- remove EL7-isms\n- explicitly require sed for building\n\n* Tue Jul 28 2020 Fedora Release Engineering - 1.0.3-4\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_33_Mass_Rebuild\n\n* Tue May 26 2020 Miro Hrončok - 1.0.3-3\n- Rebuilt for Python 3.9\n\n* Wed Jan 29 2020 Fedora Release Engineering - 1.0.3-2\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_32_Mass_Rebuild\n\n* Mon Sep 30 2019 Rick Elrod - 1.0.3-1\n- Latest upstream\n\n* Mon Aug 19 2019 Miro Hrončok - 0.9.4-15\n- Rebuilt for Python 3.8\n\n* Thu Jul 25 2019 Fedora Release Engineering - 0.9.4-14\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_31_Mass_Rebuild\n\n* Fri Feb 01 2019 Fedora Release Engineering - 0.9.4-13\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_30_Mass_Rebuild\n\n* Fri Jul 13 2018 Fedora Release Engineering - 0.9.4-12\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_29_Mass_Rebuild\n\n* Tue Jun 19 2018 Miro Hrončok - 0.9.4-11\n- Rebuilt for Python 3.7\n\n* Wed Feb 07 2018 Fedora Release Engineering - 0.9.4-10\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_28_Mass_Rebuild\n\n* Wed Jul 26 2017 Fedora Release Engineering - 0.9.4-9\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_27_Mass_Rebuild\n\n* Fri Mar 10 2017 Ralph Bean - 0.9.4-8\n- Fix help2man usage with python3.\n https://bugzilla.redhat.com/show_bug.cgi?id=1430733\n\n* Mon Feb 27 2017 Ralph Bean - 0.9.4-7\n- Fix missing Requires. https://bugzilla.redhat.com/show_bug.cgi?id=1417730\n\n* Fri Feb 10 2017 Fedora Release Engineering - 0.9.4-6\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_26_Mass_Rebuild\n\n* Mon Jan 2 2017 Ricky Elrod - 0.9.4-5\n- Add missing Obsoletes.\n\n* Mon Jan 2 2017 Ricky Elrod - 0.9.4-4\n- Nuke python-version-specific subpackages. Just use py3 if we can.\n\n* Mon Dec 19 2016 Miro Hrončok - 0.9.4-3\n- Rebuild for Python 3.6\n\n* Tue Jul 19 2016 Fedora Release Engineering - 0.9.4-2\n- https://fedoraproject.org/wiki/Changes/Automatic_Provides_for_Python_RPM_Packages\n\n* Tue Jul 05 2016 Ricky Elrod - 0.9.4-1\n- Update to latest upstream.\n\n* Fri Jun 03 2016 Ricky Elrod - 0.9.3-4\n- Add proper Obsoletes for rhbz#1329226.\n\n* Wed Feb 03 2016 Fedora Release Engineering - 0.9.3-3\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_24_Mass_Rebuild\n\n* Mon Jan 04 2016 Ralph Bean - 0.9.3-2\n- Modernize python macros and subpackaging.\n- Move LICENSE to %%license macro.\n- Make python3 the default on modern Fedora.\n\n* Mon Jan 04 2016 Ralph Bean - 0.9.3-1\n- new version\n\n* Tue Nov 10 2015 Fedora Release Engineering - 0.9.2-3\n- Rebuilt for https://fedoraproject.org/wiki/Changes/python3.5\n\n* Wed Jun 17 2015 Fedora Release Engineering - 0.9.2-2\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_23_Mass_Rebuild\n\n* Thu Mar 26 2015 Ricky Elrod - 0.9.2-1\n- Latest upstream release.\n\n* Sat Jun 07 2014 Fedora Release Engineering - 0.8.0-3\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_21_Mass_Rebuild\n\n* Wed May 28 2014 Kalev Lember - 0.8.0-2\n- Rebuilt for https://fedoraproject.org/wiki/Changes/Python_3.4\n\n* Fri Jan 31 2014 Ricky Elrod - 0.8.0-1\n- Latest upstream release.\n\n* Fri Oct 4 2013 Ricky Elrod - 0.7.2-2\n- Add in patch to work without having python-requests 2.0.0.\n\n* Sat Sep 28 2013 Ricky Elrod - 0.7.2-1\n- Latest upstream release.\n\n* Thu Sep 5 2013 Ricky Elrod - 0.6.0-7\n- Only try building the manpage on Fedora, since RHEL's help2man doesn't\n have the --no-discard-stderr flag.\n\n* Thu Sep 5 2013 Ricky Elrod - 0.6.0-6\n- Loosen the requirement on python-pygments.\n\n* Sat Aug 03 2013 Fedora Release Engineering - 0.6.0-5\n- Rebuilt for https://fedoraproject.org/wiki/Fedora_20_Mass_Rebuild\n\n* Tue Jul 2 2013 Ricky Elrod - 0.6.0-4\n- python-requests 1.2.3 exists in rawhide now.\n\n* Sun Jun 30 2013 Ricky Elrod - 0.6.0-3\n- Patch to use python-requests 1.1.0 for now.\n\n* Sat Jun 29 2013 Ricky Elrod - 0.6.0-2\n- Update to latest upstream release.\n\n* Mon Apr 29 2013 Ricky Elrod - 0.5.0-2\n- Fix changelog messup.\n\n* Mon Apr 29 2013 Ricky Elrod - 0.5.0-1\n- Update to latest upstream release.\n\n* Mon Apr 8 2013 Ricky Elrod - 0.4.1-3\n- Fix manpage generation by exporting PYTHONPATH.\n\n* Tue Mar 26 2013 Ricky Elrod - 0.4.1-2\n- Include Python3 support, and fix other review blockers.\n\n* Mon Mar 11 2013 Ricky Elrod - 0.4.1-1\n- Update to latest upstream release\n\n* Thu Jul 19 2012 Ricky Elrod - 0.2.5-1\n- Initial build.\n" }, { "path": "docs/packaging/linux-fedora/update.sh", "content": "#!/bin/bash\n\nset -xe\n\nrm -f httpie.spec.txt\nhttps --download src.fedoraproject.org/rpms/httpie/raw/rawhide/f/httpie.spec -o httpie.spec.txt\n" }, { "path": "docs/packaging/mac-ports/Portfile", "content": "# -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8::et:sw=4:ts=4:sts=4\n\nPortSystem 1.0\nPortGroup github 1.0\nPortGroup python 1.0\n\ngithub.setup httpie httpie 2.6.0\n\nmaintainers {g5pw @g5pw} openmaintainer\ncategories net\ndescription Modern, user-friendly command-line HTTP client for the API era\nlong_description HTTPie (pronounced aych-tee-tee-pie) is a command line HTTP \\\n client. Its goal is to make CLI interaction with web \\\n services as human-friendly as possible. It provides a simple \\\n http command that allows for sending arbitrary HTTP requests \\\n using a simple and natural syntax, and displays colorized \\\n responses. HTTPie can be used for testing, debugging, and \\\n generally interacting with HTTP servers.\nplatforms darwin\nlicense BSD\nhomepage https://httpie.io/\n\nvariant python37 conflicts python36 python38 python39 python310 description \"Use Python 3.7\" {}\nvariant python38 conflicts python36 python37 python39 python310 description \"Use Python 3.8\" {}\nvariant python39 conflicts python36 python37 python38 python310 description \"Use Python 3.9\" {}\nvariant python310 conflicts python36 python37 python38 python39 description \"Use Python 3.10\" {}\n\nif {[variant_isset python37]} {\n python.default_version 37\n} elseif {[variant_isset python39]} {\n python.default_version 39\n} elseif {[variant_isset python310]} {\n python.default_version 310\n} else {\n default_variants +python38\n python.default_version 38\n}\n\ndepends_lib-append port:py${python.version}-requests \\\n port:py${python.version}-requests-toolbelt \\\n port:py${python.version}-pygments \\\n port:py${python.version}-socks \\\n port:py${python.version}-charset-normalizer \\\n port:py${python.version}-defusedxml\n\nchecksums rmd160 07b1d1592da1c505ed3ee4ef3b6056215e16e9ff \\\n sha256 63cf104bf3552305c68a74f16494a90172b15296610a875e17918e5e36373c0b \\\n size 1133491\n\npython.link_binaries_suffix\n" }, { "path": "docs/packaging/mac-ports/README.md", "content": "# HTTPie on MacPorts\n\nWelcome to the documentation about **packaging HTTPie for MacPorts**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on MacPorts, then you can find them on [that page](https://httpie.io/docs#macports).\n- If you are looking for technical information about the HTTPie packaging on MacPorts, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for MacPorts.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\n## Overall process\n\nOpen a pull request to update the [downstream file](https://github.com/macports/macports-ports/blob/master/net/httpie/Portfile) ([example](https://github.com/macports/macports-ports/pull/12583)).\n\n- Here is how to calculate the size and checksums (replace `2.5.0` with the correct version):\n\n ```bash\n # Download the archive\n $ wget https://api.github.com/repos/httpie/cli/tarball/2.5.0\n\n # Size\n $ stat --printf=\"%s\\n\" 2.5.0\n 1105185\n\n # Checksums\n $ openssl dgst -rmd160 2.5.0\n RIPEMD160(2.5.0)= 88d227d52199c232c0ddf704a219d1781b1e77ee\n $ openssl dgst -sha256 2.5.0\n SHA256(2.5.0)= 00c4b7bbe7f65abe1473f37b39d9d9f8f53f44069a430ad143a404c01c2179fc\n ```\n\n- The commit message must be `httpie: update to XXX`.\n- The commit must be signed-off (`git commit -s`).\n\n## Hacking\n\n:construction: Work in progress.\n" }, { "path": "docs/packaging/snapcraft/README.md", "content": "# HTTPie on Snapcraft\n\nWelcome to the documentation about **packaging HTTPie for Snapcraft**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on Snapcraft, then you can find them on [that page](https://httpie.io/docs#snapcraft-linux) ([that one](https://httpie.io/docs#snapcraft-macos) for macOS).\n- If you are looking for technical information about the HTTPie packaging on Snapcraft, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for Snapcraft. They apply to Snapcraft on Linux, macOS, and Windows.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\n## Overall process\n\nTrigger the [`Release on Snap`](https://github.com/httpie/cli/actions/workflows/release-snap.yml) action, which will\ncreate a snap package for HTTPie and then push it to Snap Store in the following channels:\n\n- Edge\n- Beta\n- Candidate\n- Stable\n\nIf a push to any of them fail, all the release tasks for the following channels will be cancelled so that the\nrelease manager can look into the underlying cause.\n\n## Hacking\n\nLaunch the docker image:\n\n```bash\ndocker pull ubuntu/latest\ndocker run -it --rm ubuntu/latest\n```\n\nFrom inside the container:\n\n```bash\n# Clone\ngit clone --depth=1 https://github.com/httpie/cli.git\ncd httpie\n\n# Build\nexport SNAPCRAFT_BUILD_ENVIRONMENT_CPU=8\nexport SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=16G\nsnapcraft --debug\n\n# Install\nsudo snap install --dangerous httpie_XXX_amd64.snap\n\n# Test\nhttpie.http --version\nhttpie.https --version\n# Auto-aliases cannot be tested when installing a snap outside the store.\n# http --version\n# https --version\n\n# Remove\nsudo snap remove httpie\n```\n" }, { "path": "docs/packaging/windows-chocolatey/README.md", "content": "# HTTPie on Chocolatey\n\nWelcome to the documentation about **packaging HTTPie for Chocolatey**.\n\n- If you do not know HTTPie, have a look [here](https://httpie.io/cli).\n- If you are looking for HTTPie installation or upgrade instructions on Chocolatey, then you can find them on [that page](https://httpie.io/docs#chocolatey).\n- If you are looking for technical information about the HTTPie packaging on Chocolatey, then you are in a good place.\n\n## About\n\nThis document contains technical details, where we describe how to create a patch for the latest HTTPie version for Chocolatey.\nWe will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.\n\n## Overall process\n\nAfter having successfully [built and tested](#hacking) the package, either trigger the\n[`Release on Chocolatey`](https://github.com/httpie/cli/actions/workflows/release-choco.yml) action\nto push it to the `Chocolatey` store or use the CLI:\n\n```bash\n# Replace 2.5.0 with the correct version\nchoco push httpie.2.5.0.nupkg -s https://push.chocolatey.org/ --api-key=API_KEY\n```\n\nBe aware that it might take multiple days until the release is approved, sine it goes through multiple\nsets of reviews (some of them are done manually).\n\n## Hacking\n\n```bash\n# Clone\ngit clone --depth=1 https://github.com/httpie/cli.git\ncd httpie/docs/packaging/windows-chocolatey\n\n# Build\nchoco pack\n\n# Check metadata\nchoco info httpie -s .\n\n# Install\nchoco install httpie -y -dv -s \"'.;https://community.chocolatey.org/api/v2/'\"\n\n# Test\nhttp --version\nhttps --version\n\n# Remove\nchoco uninstall -y httpie\n```\n" }, { "path": "docs/packaging/windows-chocolatey/httpie.nuspec", "content": "\n\n\t\n\t\thttpie\n\t\t3.2.2\n\t\tModern, user-friendly command-line HTTP client for the API era\n\t\t\nHTTPie *aitch-tee-tee-pie* is a user-friendly command-line HTTP client for the API era.\nIt comes with JSON support, syntax highlighting, persistent sessions, wget-like downloads, plugins, and more.\n\nThe project's goal is to make CLI interaction with web services as human-friendly as possible. HTTPie is designed for testing, debugging, and generally interacting with APIs and HTTP servers.\nThe `http` and `https` commands allow for creating and sending arbitrary HTTP requests. They use simple and natural syntax and provide formatted and colorized output.\n\nMain features:\n\n- Built-in JSON support\n- Colorized and formatted terminal output\n- Sensible defaults for the API era\n- Persistent sessions\n- Forms and file uploads\n- HTTPS, proxies, and authentication support\n- Support for arbitrary request data and headers\n- Wget-like downloads\n- Extensions API\n- Expressive and intuitive syntax\n- Linux, macOS, Windows, and FreeBSD support\n- All that and more in 2 simple commands: `http` + `https`\n\t\t\n\t\tHTTPie\n\t\tHTTPie\n\t\tjakubroztocil\n\t\t2012-2022 Jakub Roztocil\n\t\thttps://raw.githubusercontent.com/httpie/cli/master/LICENSE\n\t\thttps://pie-assets.s3.eu-central-1.amazonaws.com/LogoIcons/GB.png\n\t\tfalse\n\t\tSee the [changelog](https://github.com/httpie/cli/releases/tag/3.2.2).\n\t\thttpie http https rest api client curl python ssl cli foss oss url\n\t\thttps://httpie.io\n\t\thttps://github.com/httpie/cli/tree/master/docs/packaging/windows-chocolatey\n\t\thttps://github.com/httpie/cli\n\t\thttps://httpie.io/docs\n\t\thttps://github.com/httpie/cli/issues\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\n\n" }, { "path": "docs/packaging/windows-chocolatey/tools/chocolateyinstall.ps1", "content": "$ErrorActionPreference = 'Stop';\npy -m pip install $env:ChocolateyPackageName==$env:ChocolateyPackageVersion --disable-pip-version-check\n" }, { "path": "docs/packaging/windows-chocolatey/tools/chocolateyuninstall.ps1", "content": "$ErrorActionPreference = 'Stop';\npy -m pip uninstall -y $env:ChocolateyPackageName --disable-pip-version-check\n" }, { "path": "extras/httpie-completion.bash", "content": "_http_complete() {\n local cur_word=${COMP_WORDS[COMP_CWORD]}\n local prev_word=${COMP_WORDS[COMP_CWORD - 1]}\n\n if [[ \"$cur_word\" == -* ]]; then\n _http_complete_options \"$cur_word\"\n fi\n}\n\ncomplete -o default -F _http_complete http httpie.http httpie.https https\n\n_http_complete_options() {\n local cur_word=$1\n local options=\"-j --json -f --form --pretty -s --style -p --print\n -v --verbose -h --headers -b --body -S --stream -o --output -d --download\n -c --continue --session --session-read-only -a --auth --auth-type --proxy\n --follow --verify --cert --cert-key --timeout --check-status --ignore-stdin\n --help --version --traceback --debug --raw\"\n COMPREPLY=( $( compgen -W \"$options\" -- \"$cur_word\" ) )\n}\n" }, { "path": "extras/httpie-completion.fish", "content": "function __fish_httpie_styles\n printf '%s\\n' abap algol algol_nu arduino auto autumn borland bw colorful default emacs friendly fruity gruvbox-dark gruvbox-light igor inkpot lovelace manni material monokai murphy native paraiso-dark paraiso-light pastie perldoc pie pie-dark pie-light rainbow_dash rrt sas solarized solarized-dark solarized-light stata stata-dark stata-light tango trac vim vs xcode zenburn\nend\n\nfunction __fish_httpie_mime_types\n test -r /usr/share/mime/types && cat /usr/share/mime/types\nend\n\nfunction __fish_httpie_print_args\n set -l arg (commandline -t)\n string match -qe H \"$arg\" || echo -e $arg\"H\\trequest headers\"\n string match -qe B \"$arg\" || echo -e $arg\"B\\trequest body\"\n string match -qe h \"$arg\" || echo -e $arg\"h\\tresponse headers\"\n string match -qe b \"$arg\" || echo -e $arg\"b\\tresponse body\"\n string match -qe m \"$arg\" || echo -e $arg\"m\\tresponse metadata\"\nend\n\nfunction __fish_httpie_auth_types\n echo -e \"basic\\tBasic HTTP auth\"\n echo -e \"digest\\tDigest HTTP auth\"\n echo -e \"bearer\\tBearer HTTP Auth\"\nend\n\nfunction __fish_http_verify_options\n echo -e \"yes\\tEnable cert verification\"\n echo -e \"no\\tDisable cert verification\"\nend\n\n\n# Predefined Content Types\n\ncomplete -c http -s j -l json -d 'Data items are serialized as a JSON object'\ncomplete -c http -s f -l form -d 'Data items are serialized as form fields'\ncomplete -c http -l multipart -d 'Always sends a multipart/form-data request'\ncomplete -c http -l boundary -x -d 'Custom boundary string for multipart/form-data requests'\ncomplete -c http -l raw -x -d 'Pass raw request data without extra processing'\n\n\n# Content Processing Options\n\ncomplete -c http -s x -l compress -d 'Content compressed with Deflate algorithm'\n\n\n# Output Processing\n\ncomplete -c http -l pretty -xa \"all colors format none\" -d 'Controls output processing'\ncomplete -c http -s s -l style -xa \"(__fish_httpie_styles)\" -d 'Output coloring style'\ncomplete -c http -l unsorted -d 'Disables all sorting while formatting output'\ncomplete -c http -l sorted -d 'Re-enables all sorting options while formatting output'\ncomplete -c http -l response-charset -x -d 'Override the response encoding'\ncomplete -c http -l response-mime -xa \"(__fish_httpie_mime_types)\" -d 'Override the response mime type for coloring and formatting'\ncomplete -c http -l format-options -x -d 'Controls output formatting'\n\n\n# Output Options\n\ncomplete -c http -s p -l print -xa \"(__fish_httpie_print_args)\" -d 'String specifying what the output should contain'\ncomplete -c http -s h -l headers -d 'Print only the response headers'\ncomplete -c http -s m -l meta -d 'Print only the response metadata'\ncomplete -c http -s b -l body -d 'Print only the response body'\ncomplete -c http -s v -l verbose -d 'Print the whole request as well as the response'\ncomplete -c http -l all -d 'Show any intermediary requests/responses'\ncomplete -c http -s S -l stream -d 'Always stream the response body by line'\ncomplete -c http -s o -l output -F -d 'Save output to FILE'\ncomplete -c http -s d -l download -d 'Download a file'\ncomplete -c http -s c -l continue -d 'Resume an interrupted download'\ncomplete -c http -s q -l quiet -d 'Do not print to stdout or stderr'\n\n\n# Sessions\n\ncomplete -c http -l session -F -d 'Create, or reuse and update a session'\ncomplete -c http -l session-read-only -F -d 'Create or read a session without updating it'\n\n\n# Authentication\n\ncomplete -c http -s a -l auth -x -d 'Username and password for authentication'\ncomplete -c http -s A -l auth-type -xa \"(__fish_httpie_auth_types)\" -d 'The authentication mechanism to be used'\ncomplete -c http -l ignore-netrc -d 'Ignore credentials from .netrc'\n\n\n# Network\n\ncomplete -c http -l offline -d 'Build the request and print it but don\\'t actually send it'\ncomplete -c http -l proxy -x -d 'String mapping protocol to the URL of the proxy'\ncomplete -c http -s F -l follow -d 'Follow 30x Location redirects'\ncomplete -c http -l max-redirects -x -d 'Set maximum number of redirects'\ncomplete -c http -l max-headers -x -d 'Maximum number of response headers to be read before giving up'\ncomplete -c http -l timeout -x -d 'Connection timeout in seconds'\ncomplete -c http -l check-status -d 'Error with non-200 HTTP status code'\ncomplete -c http -l path-as-is -d 'Bypass dot segment URL squashing'\ncomplete -c http -l chunked -d 'Enable streaming via chunked transfer encoding'\n\n\n# SSL\n\ncomplete -c http -l verify -xa \"(__fish_http_verify_options)\" -d 'Enable/disable cert verification'\ncomplete -c http -l ssl -x -d 'Desired protocol version to use'\ncomplete -c http -l ciphers -x -d 'String in the OpenSSL cipher list format'\ncomplete -c http -l cert -F -d 'Client side SSL certificate'\ncomplete -c http -l cert-key -F -d 'Private key to use with SSL'\ncomplete -c http -l cert-key-pass -x -d 'Passphrase for the given private key'\n\n\n# Troubleshooting\n\ncomplete -c http -s I -l ignore-stdin -d 'Do not attempt to read stdin'\ncomplete -c http -l help -d 'Show help'\ncomplete -c http -l manual -d 'Show the full manual'\ncomplete -c http -l version -d 'Show version'\ncomplete -c http -l traceback -d 'Prints exception traceback should one occur'\ncomplete -c http -l default-scheme -x -d 'The default scheme to use'\ncomplete -c http -l debug -d 'Show debugging output'\n\n\n# Alias for https to http\n\ncomplete -c https -w http\n" }, { "path": "extras/man/http.1", "content": ".\\\" This file is auto-generated from the parser declaration in httpie/cli/definition.py by extras/scripts/generate_man_pages.py.\n.TH http 1 \"2024-11-01\" \"HTTPie 3.2.4\" \"HTTPie Manual\"\n.SH NAME\nhttp\n.SH SYNOPSIS\nhttp [METHOD] URL [REQUEST_ITEM ...]\n\n.SH DESCRIPTION\nHTTPie: modern, user-friendly command-line HTTP client for the API era. \n.SH Positional arguments\n\nThese arguments come after any flags and in the order they are listed here.\nOnly URL is required.\n\n.IP \"\\fB\\,METHOD\\/\\fR\"\n\n\nThe HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).\n\nThis argument can be omitted in which case HTTPie will use POST if there\nis some data to be sent, otherwise GET:\n\n $ http example.org # => GET\n $ http example.org hello=world # => POST\n\n\n\n.IP \"\\fB\\,URL\\/\\fR\"\n\n\nThe request URL. Scheme defaults to \\[aq]http://\\[aq] if the URL\ndoes not include one. (You can override this with: \\fB\\,--default-scheme\\/\\fR=http/https)\n\nYou can also use a shorthand for localhost\n\n $ http :3000 # => http://localhost:3000\n $ http :/foo # => http://localhost/foo\n\n\n\n.IP \"\\fB\\,REQUEST_ITEM\\/\\fR\"\n\n\nOptional key-value pairs to be included in the request. The separator used\ndetermines the type:\n\n\\[aq]:\\[aq] HTTP headers:\n\n Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0\n\n\\[aq]==\\[aq] URL parameters to be appended to the request URI:\n\n search==httpie\n\n\\[aq]=\\[aq] Data fields to be serialized into a JSON object (with \\fB\\,--json\\/\\fR, \\fB\\,-j\\/\\fR)\n or form data (with \\fB\\,--form\\/\\fR, \\fB\\,-f\\/\\fR):\n\n name=HTTPie language=Python description=\\[aq]CLI HTTP client\\[aq]\n\n\\[aq]:=\\[aq] Non-string JSON data fields (only with \\fB\\,--json\\/\\fR, \\fB\\,-j\\/\\fR):\n\n awesome:=true amount:=42 colors:=\\[aq][\\[dq]red\\[dq], \\[dq]green\\[dq], \\[dq]blue\\[dq]]\\[aq]\n\n\\[aq]@\\[aq] Form file fields (only with \\fB\\,--form\\/\\fR or \\fB\\,--multipart\\/\\fR):\n\n cv@\\(ti/Documents/CV.pdf\n cv@\\[aq]\\(ti/Documents/CV.pdf;type=application/pdf\\[aq]\n\n\\[aq]=@\\[aq] A data field like \\[aq]=\\[aq], but takes a file path and embeds its content:\n\n essay=@Documents/essay.txt\n\n\\[aq]:=@\\[aq] A raw JSON field like \\[aq]:=\\[aq], but takes a file path and embeds its content:\n\n package:=@./package.json\n\nYou can use a backslash to escape a colliding separator in the field name:\n\n field-name-with\\e:colon=value\n\n\n\n.PP\n.SH Predefined content types\n.IP \"\\fB\\,--json\\/\\fR, \\fB\\,-j\\/\\fR\"\n\n\n(default) Data items from the command line are serialized as a JSON object.\nThe Content-Type and Accept headers are set to application/json\n(if not specified).\n\n\n\n.IP \"\\fB\\,--form\\/\\fR, \\fB\\,-f\\/\\fR\"\n\n\nData items from the command line are serialized as form fields.\n\nThe Content-Type is set to application/x-www-form-urlencoded (if not\nspecified). The presence of any file fields results in a\nmultipart/form-data request.\n\n\n\n.IP \"\\fB\\,--multipart\\/\\fR\"\n\n\nSimilar to \\fB\\,--form\\/\\fR, but always sends a multipart/form-data request (i.e., even without files).\n\n\n.IP \"\\fB\\,--boundary\\/\\fR\"\n\n\nSpecify a custom boundary string for multipart/form-data requests. Only has effect only together with \\fB\\,--form\\/\\fR.\n\n\n.IP \"\\fB\\,--raw\\/\\fR\"\n\n\nThis option allows you to pass raw request data without extra processing\n(as opposed to the structured request items syntax):\n\n $ http \\fB\\,--raw\\/\\fR=\\[aq]data\\[aq] pie.dev/post\n\nYou can achieve the same by piping the data via stdin:\n\n $ echo data | http pie.dev/post\n\nOr have HTTPie load the raw data from a file:\n\n $ http pie.dev/post @data.txt\n\n\n\n\n.PP\n.SH Content processing options\n.IP \"\\fB\\,--compress\\/\\fR, \\fB\\,-x\\/\\fR\"\n\n\nContent compressed (encoded) with Deflate algorithm.\nThe Content-Encoding header is set to deflate.\n\nCompression is skipped if it appears that compression ratio is\nnegative. Compression can be forced by repeating the argument.\n\n\n\n.PP\n.SH Output processing\n.IP \"\\fB\\,--pretty\\/\\fR\"\n\n\nControls output processing. The value can be \\[dq]none\\[dq] to not prettify\nthe output (default for redirected output), \\[dq]all\\[dq] to apply both colors\nand formatting (default for terminal output), \\[dq]colors\\[dq], or \\[dq]format\\[dq].\n\n\n\n.IP \"\\fB\\,--style\\/\\fR, \\fB\\,-s\\/\\fR \\fI\\,STYLE\\/\\fR\"\n\n\nOutput coloring style (default is \\[dq]auto\\[dq]). It can be one of:\n\n auto, pie, pie-dark, pie-light, solarized\n\n\nFor finding out all available styles in your system, try:\n\n$ http \\fB\\,--style\\/\\fR\n\nThe \\[dq]auto\\[dq] style follows your terminal\\[aq]s ANSI color styles.\nFor non-auto styles to work properly, please make sure that the\n$TERM environment variable is set to \\[dq]xterm-256color\\[dq] or similar\n(e.g., via `export TERM=xterm-256color\\[aq] in your \\(ti/.bashrc).\n\n.IP \"\\fB\\,--unsorted\\/\\fR\"\n\n\nDisables all sorting while formatting output. It is a shortcut for:\n\n \\fB\\,--format-options\\/\\fR=headers.sort:false,json.sort_keys:false\n\n\n\n.IP \"\\fB\\,--sorted\\/\\fR\"\n\n\nRe-enables all sorting options while formatting output. It is a shortcut for:\n\n \\fB\\,--format-options\\/\\fR=headers.sort:true,json.sort_keys:true\n\n\n\n.IP \"\\fB\\,--response-charset\\/\\fR \\fI\\,ENCODING\\/\\fR\"\n\n\nOverride the response encoding for terminal display purposes, e.g.:\n\n \\fB\\,--response-charset\\/\\fR=utf8\n \\fB\\,--response-charset\\/\\fR=big5\n\n\n\n.IP \"\\fB\\,--response-mime\\/\\fR \\fI\\,MIME_TYPE\\/\\fR\"\n\n\nOverride the response mime type for coloring and formatting for the terminal, e.g.:\n\n \\fB\\,--response-mime\\/\\fR=application/json\n \\fB\\,--response-mime\\/\\fR=text/xml\n\n\n\n.IP \"\\fB\\,--format-options\\/\\fR\"\n\n\nControls output formatting. Only relevant when formatting is enabled\nthrough (explicit or implied) \\fB\\,--pretty\\/\\fR=all or \\fB\\,--pretty\\/\\fR=format.\nThe following are the default options:\n\n headers.sort:true\n json.format:true\n json.indent:4\n json.sort_keys:true\n xml.format:true\n xml.indent:2\n\nYou may use this option multiple times, as well as specify multiple\ncomma-separated options at the same time. For example, this modifies the\nsettings to disable the sorting of JSON keys, and sets the indent size to 2:\n\n \\fB\\,--format-options\\/\\fR json.sort_keys:false,json.indent:2\n\nThis is something you will typically put into your config file.\n\n\n\n.PP\n.SH Output options\n.IP \"\\fB\\,--print\\/\\fR, \\fB\\,-p\\/\\fR \\fI\\,WHAT\\/\\fR\"\n\n\nString specifying what the output should contain:\n\n \\[aq]H\\[aq] request headers\n \\[aq]B\\[aq] request body\n \\[aq]h\\[aq] response headers\n \\[aq]b\\[aq] response body\n \\[aq]m\\[aq] response metadata\n\nThe default behaviour is \\[aq]hb\\[aq] (i.e., the response\nheaders and body is printed), if standard output is not redirected.\nIf the output is piped to another program or to a file, then only the\nresponse body is printed by default.\n\n\n\n.IP \"\\fB\\,--headers\\/\\fR, \\fB\\,-h\\/\\fR\"\n\n\nPrint only the response headers. Shortcut for \\fB\\,--print\\/\\fR=h.\n\n\n\n.IP \"\\fB\\,--meta\\/\\fR, \\fB\\,-m\\/\\fR\"\n\n\nPrint only the response metadata. Shortcut for \\fB\\,--print\\/\\fR=m.\n\n\n\n.IP \"\\fB\\,--body\\/\\fR, \\fB\\,-b\\/\\fR\"\n\n\nPrint only the response body. Shortcut for \\fB\\,--print\\/\\fR=b.\n\n\n\n.IP \"\\fB\\,--verbose\\/\\fR, \\fB\\,-v\\/\\fR\"\n\n\nVerbose output. For the level one (with single `\\fB\\,-v\\/\\fR`/`\\fB\\,--verbose\\/\\fR`), print\nthe whole request as well as the response. Also print any intermediary\nrequests/responses (such as redirects). For the second level and higher,\nprint these as well as the response metadata.\n\nLevel one is a shortcut for: \\fB\\,--all\\/\\fR \\fB\\,--print\\/\\fR=BHbh\nLevel two is a shortcut for: \\fB\\,--all\\/\\fR \\fB\\,--print\\/\\fR=BHbhm\n\n\n.IP \"\\fB\\,--all\\/\\fR\"\n\n\nBy default, only the final request/response is shown. Use this flag to show\nany intermediary requests/responses as well. Intermediary requests include\nfollowed redirects (with \\fB\\,--follow\\/\\fR), the first unauthorized request when\nDigest auth is used (\\fB\\,--auth\\/\\fR=digest), etc.\n\n\n\n.IP \"\\fB\\,--stream\\/\\fR, \\fB\\,-S\\/\\fR\"\n\n\nAlways stream the response body by line, i.e., behave like `tail \\fB\\,-f\\/\\fR\\[aq].\n\nWithout \\fB\\,--stream\\/\\fR and with \\fB\\,--pretty\\/\\fR (either set or implied),\nHTTPie fetches the whole response before it outputs the processed data.\n\nSet this option when you want to continuously display a prettified\nlong-lived response, such as one from the Twitter streaming API.\n\nIt is useful also without \\fB\\,--pretty\\/\\fR: It ensures that the output is flushed\nmore often and in smaller chunks.\n\n\n\n.IP \"\\fB\\,--output\\/\\fR, \\fB\\,-o\\/\\fR \\fI\\,FILE\\/\\fR\"\n\n\nSave output to FILE instead of stdout. If \\fB\\,--download\\/\\fR is also set, then only\nthe response body is saved to FILE. Other parts of the HTTP exchange are\nprinted to stderr.\n\n\n\n.IP \"\\fB\\,--download\\/\\fR, \\fB\\,-d\\/\\fR\"\n\n\nDo not print the response body to stdout. Rather, download it and store it\nin a file. The filename is guessed unless specified with \\fB\\,--output\\/\\fR\n[filename]. This action is similar to the default behaviour of wget.\n\n\n\n.IP \"\\fB\\,--continue\\/\\fR, \\fB\\,-c\\/\\fR\"\n\n\nResume an interrupted download. Note that the \\fB\\,--output\\/\\fR option needs to be\nspecified as well.\n\n\n\n.IP \"\\fB\\,--quiet\\/\\fR, \\fB\\,-q\\/\\fR\"\n\n\nDo not print to stdout or stderr, except for errors and warnings when provided once.\nProvide twice to suppress warnings as well.\nstdout is still redirected if \\fB\\,--output\\/\\fR is specified.\nFlag doesn\\[aq]t affect behaviour of download beyond not printing to terminal.\n\n\n\n.PP\n.SH Sessions\n.IP \"\\fB\\,--session\\/\\fR \\fI\\,SESSION_NAME_OR_PATH\\/\\fR\"\n\n\nCreate, or reuse and update a session. Within a session, custom headers,\nauth credential, as well as any cookies sent by the server persist between\nrequests.\n\nSession files are stored in:\n\n [HTTPIE_CONFIG_DIR]//.json.\n\nSee the following page to find out your default HTTPIE_CONFIG_DIR:\n\n https://httpie.io/docs/cli/config-file-directory\n\n\n.IP \"\\fB\\,--session-read-only\\/\\fR \\fI\\,SESSION_NAME_OR_PATH\\/\\fR\"\n\n\nCreate or read a session without updating it form the request/response\nexchange.\n\n\n\n.PP\n.SH Authentication\n.IP \"\\fB\\,--auth\\/\\fR, \\fB\\,-a\\/\\fR \\fI\\,USER[:PASS] | TOKEN\\/\\fR\"\n\n\nFor username/password based authentication mechanisms (e.g\nbasic auth or digest auth) if only the username is provided\n(\\fB\\,-a\\/\\fR username), HTTPie will prompt for the password.\n\n\n\n.IP \"\\fB\\,--auth-type\\/\\fR, \\fB\\,-A\\/\\fR\"\n\n\nThe authentication mechanism to be used. Defaults to \\[dq]basic\\[dq].\n\n\\[dq]basic\\[dq]: Basic HTTP auth\n\n\\[dq]digest\\[dq]: Digest HTTP auth\n\n\\[dq]bearer\\[dq]: Bearer HTTP Auth\n\nTo see all available auth types on your system, including ones installed via plugins, run:\n\n$ http \\fB\\,--auth-type\\/\\fR\n\n.IP \"\\fB\\,--ignore-netrc\\/\\fR\"\n\n\nIgnore credentials from .netrc.\n\n\n.PP\n.SH Network\n.IP \"\\fB\\,--offline\\/\\fR\"\n\n\nBuild the request and print it but don\\(gat actually send it.\n\n\n.IP \"\\fB\\,--proxy\\/\\fR \\fI\\,PROTOCOL:PROXY_URL\\/\\fR\"\n\n\nString mapping protocol to the URL of the proxy\n(e.g. http:http://foo.bar:3128). You can specify multiple proxies with\ndifferent protocols. The environment variables $ALL_PROXY, $HTTP_PROXY,\nand $HTTPS_proxy are supported as well.\n\n\n\n.IP \"\\fB\\,--follow\\/\\fR, \\fB\\,-F\\/\\fR\"\n\n\nFollow 30x Location redirects.\n\n\n.IP \"\\fB\\,--max-redirects\\/\\fR\"\n\n\nBy default, requests have a limit of 30 redirects (works with \\fB\\,--follow\\/\\fR).\n\n\n\n.IP \"\\fB\\,--max-headers\\/\\fR\"\n\n\nThe maximum number of response headers to be read before giving up (default 0, i.e., no limit).\n\n\n.IP \"\\fB\\,--timeout\\/\\fR \\fI\\,SECONDS\\/\\fR\"\n\n\nThe connection timeout of the request in seconds.\nThe default value is 0, i.e., there is no timeout limit.\nThis is not a time limit on the entire response download;\nrather, an error is reported if the server has not issued a response for\ntimeout seconds (more precisely, if no bytes have been received on\nthe underlying socket for timeout seconds).\n\n\n\n.IP \"\\fB\\,--check-status\\/\\fR\"\n\n\nBy default, HTTPie exits with 0 when no network or other fatal errors\noccur. This flag instructs HTTPie to also check the HTTP status code and\nexit with an error if the status indicates one.\n\nWhen the server replies with a 4xx (Client Error) or 5xx (Server Error)\nstatus code, HTTPie exits with 4 or 5 respectively. If the response is a\n3xx (Redirect) and \\fB\\,--follow\\/\\fR hasn\\[aq]t been set, then the exit status is 3.\nAlso an error message is written to stderr if stdout is redirected.\n\n\n\n.IP \"\\fB\\,--path-as-is\\/\\fR\"\n\n\nBypass dot segment (/../ or /./) URL squashing.\n\n\n.IP \"\\fB\\,--chunked\\/\\fR\"\n\n\nEnable streaming via chunked transfer encoding. The Transfer-Encoding header is set to chunked.\n\n\n.PP\n.SH SSL\n.IP \"\\fB\\,--verify\\/\\fR\"\n\n\nSet to \\[dq]no\\[dq] (or \\[dq]false\\[dq]) to skip checking the host\\[aq]s SSL certificate.\nDefaults to \\[dq]yes\\[dq] (\\[dq]true\\[dq]). You can also pass the path to a CA_BUNDLE file\nfor private certs. (Or you can set the REQUESTS_CA_BUNDLE environment\nvariable instead.)\n\n\n.IP \"\\fB\\,--ssl\\/\\fR\"\n\n\nThe desired protocol version to use. This will default to\nSSL v2.3 which will negotiate the highest protocol that both\nthe server and your installation of OpenSSL support. Available protocols\nmay vary depending on OpenSSL installation (only the supported ones\nare shown here).\n\n\n\n.IP \"\\fB\\,--ciphers\\/\\fR\"\n\n\n\nA string in the OpenSSL cipher list format.\n\n\nSee `http \\fB\\,--help\\/\\fR` for the default ciphers list on you system.\n\n\n\n\n\n.IP \"\\fB\\,--cert\\/\\fR\"\n\n\nYou can specify a local cert to use as client side SSL certificate.\nThis file may either contain both private key and certificate or you may\nspecify \\fB\\,--cert-key\\/\\fR separately.\n\n\n\n.IP \"\\fB\\,--cert-key\\/\\fR\"\n\n\nThe private key to use with SSL. Only needed if \\fB\\,--cert\\/\\fR is given and the\ncertificate file does not contain the private key.\n\n\n\n.IP \"\\fB\\,--cert-key-pass\\/\\fR\"\n\n\nThe passphrase to be used to with the given private key. Only needed if \\fB\\,--cert-key\\/\\fR\nis given and the key file requires a passphrase.\nIf not provided, you\\(gall be prompted interactively.\n\n\n.PP\n.SH Troubleshooting\n.IP \"\\fB\\,--ignore-stdin\\/\\fR, \\fB\\,-I\\/\\fR\"\n\n\nDo not attempt to read stdin\n\n\n.IP \"\\fB\\,--help\\/\\fR\"\n\n\nShow this help message and exit.\n\n\n.IP \"\\fB\\,--manual\\/\\fR\"\n\n\nShow the full manual.\n\n\n.IP \"\\fB\\,--version\\/\\fR\"\n\n\nShow version and exit.\n\n\n.IP \"\\fB\\,--traceback\\/\\fR\"\n\n\nPrints the exception traceback should one occur.\n\n\n.IP \"\\fB\\,--default-scheme\\/\\fR\"\n\n\nThe default scheme to use if not specified in the URL.\n\n\n.IP \"\\fB\\,--debug\\/\\fR\"\n\n\nPrints the exception traceback should one occur, as well as other\ninformation useful for debugging HTTPie itself and for reporting bugs.\n\n\n\n.PP\n.SH SEE ALSO\n\nFor every \\fB\\,--OPTION\\/\\fR there is also a \\fB\\,--no-OPTION\\/\\fR that reverts OPTION\nto its default value.\n\nSuggestions and bug reports are greatly appreciated:\nhttps://github.com/httpie/cli/issues" }, { "path": "extras/man/httpie.1", "content": ".\\\" This file is auto-generated from the parser declaration in httpie/manager/cli.py by extras/scripts/generate_man_pages.py.\n.TH httpie 1 \"2024-11-01\" \"HTTPie 3.2.4\" \"HTTPie Manual\"\n.SH NAME\nhttpie\n.SH SYNOPSIS\nhttpie\n.SH DESCRIPTION\n\nManaging interface for the HTTPie itself. \n\nBe aware that you might be looking for http/https commands for sending\nHTTP requests. This command is only available for managing the HTTTPie\nplugins and the configuration around it.\n\n\nIf you are looking for the man pages of http/https commands, try one of the following:\n $ man http\n $ man https\n\n\n.SH httpie cli export-args\nExport available options for the CLI\n.IP \"\\fB\\,-f\\/\\fR, \\fB\\,--format\\/\\fR\"\n\nFormat to export in.\n\n.PP\n.SH httpie cli check-updates\nCheck for updates\n.PP\n.SH httpie cli sessions upgrade\nUpgrade the given HTTPie session with the latest layout. A list of changes between different session versions can be found in the official documentation.\n.IP \"\\fB\\,HOSTNAME\\/\\fR\"\n\nThe host this session belongs.\n\n.IP \"\\fB\\,SESSION_NAME_OR_PATH\\/\\fR\"\n\nThe name or the path for the session that will be upgraded.\n\n.IP \"\\fB\\,--bind-cookies\\/\\fR\"\n\nBind domainless cookies to the host that session belongs.\n\n.PP\n.SH httpie cli sessions upgrade-all\nUpgrade all named sessions with the latest layout. A list of changes between different session versions can be found in the official documentation.\n.IP \"\\fB\\,--bind-cookies\\/\\fR\"\n\nBind domainless cookies to the host that session belongs.\n\n.PP\n.SH httpie cli plugins install\nInstall the given targets from PyPI or from a local paths.\n.IP \"\\fB\\,TARGET\\/\\fR\"\n\ntargets to install\n\n.PP\n.SH httpie cli plugins upgrade\nUpgrade the given plugins\n.IP \"\\fB\\,TARGET\\/\\fR\"\n\ntargets to upgrade\n\n.PP\n.SH httpie cli plugins uninstall\nUninstall the given HTTPie plugins.\n.IP \"\\fB\\,TARGET\\/\\fR\"\n\ntargets to install\n\n.PP\n.SH httpie cli plugins list\nList all installed HTTPie plugins.\n.PP\n.SH httpie plugins install\nInstall the given targets from PyPI or from a local paths.\n.IP \"\\fB\\,TARGET\\/\\fR\"\n\ntargets to install\n\n.PP\n.SH httpie plugins upgrade\nUpgrade the given plugins\n.IP \"\\fB\\,TARGET\\/\\fR\"\n\ntargets to upgrade\n\n.PP\n.SH httpie plugins uninstall\nUninstall the given HTTPie plugins.\n.IP \"\\fB\\,TARGET\\/\\fR\"\n\ntargets to install\n\n.PP\n.SH httpie plugins list\nList all installed HTTPie plugins.\n.PP" }, { "path": "extras/man/https.1", "content": ".\\\" This file is auto-generated from the parser declaration in httpie/cli/definition.py by extras/scripts/generate_man_pages.py.\n.TH https 1 \"2024-11-01\" \"HTTPie 3.2.4\" \"HTTPie Manual\"\n.SH NAME\nhttps\n.SH SYNOPSIS\nhttps [METHOD] URL [REQUEST_ITEM ...]\n\n.SH DESCRIPTION\nHTTPie: modern, user-friendly command-line HTTP client for the API era. \n.SH Positional arguments\n\nThese arguments come after any flags and in the order they are listed here.\nOnly URL is required.\n\n.IP \"\\fB\\,METHOD\\/\\fR\"\n\n\nThe HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).\n\nThis argument can be omitted in which case HTTPie will use POST if there\nis some data to be sent, otherwise GET:\n\n $ http example.org # => GET\n $ http example.org hello=world # => POST\n\n\n\n.IP \"\\fB\\,URL\\/\\fR\"\n\n\nThe request URL. Scheme defaults to \\[aq]http://\\[aq] if the URL\ndoes not include one. (You can override this with: \\fB\\,--default-scheme\\/\\fR=http/https)\n\nYou can also use a shorthand for localhost\n\n $ http :3000 # => http://localhost:3000\n $ http :/foo # => http://localhost/foo\n\n\n\n.IP \"\\fB\\,REQUEST_ITEM\\/\\fR\"\n\n\nOptional key-value pairs to be included in the request. The separator used\ndetermines the type:\n\n\\[aq]:\\[aq] HTTP headers:\n\n Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0\n\n\\[aq]==\\[aq] URL parameters to be appended to the request URI:\n\n search==httpie\n\n\\[aq]=\\[aq] Data fields to be serialized into a JSON object (with \\fB\\,--json\\/\\fR, \\fB\\,-j\\/\\fR)\n or form data (with \\fB\\,--form\\/\\fR, \\fB\\,-f\\/\\fR):\n\n name=HTTPie language=Python description=\\[aq]CLI HTTP client\\[aq]\n\n\\[aq]:=\\[aq] Non-string JSON data fields (only with \\fB\\,--json\\/\\fR, \\fB\\,-j\\/\\fR):\n\n awesome:=true amount:=42 colors:=\\[aq][\\[dq]red\\[dq], \\[dq]green\\[dq], \\[dq]blue\\[dq]]\\[aq]\n\n\\[aq]@\\[aq] Form file fields (only with \\fB\\,--form\\/\\fR or \\fB\\,--multipart\\/\\fR):\n\n cv@\\(ti/Documents/CV.pdf\n cv@\\[aq]\\(ti/Documents/CV.pdf;type=application/pdf\\[aq]\n\n\\[aq]=@\\[aq] A data field like \\[aq]=\\[aq], but takes a file path and embeds its content:\n\n essay=@Documents/essay.txt\n\n\\[aq]:=@\\[aq] A raw JSON field like \\[aq]:=\\[aq], but takes a file path and embeds its content:\n\n package:=@./package.json\n\nYou can use a backslash to escape a colliding separator in the field name:\n\n field-name-with\\e:colon=value\n\n\n\n.PP\n.SH Predefined content types\n.IP \"\\fB\\,--json\\/\\fR, \\fB\\,-j\\/\\fR\"\n\n\n(default) Data items from the command line are serialized as a JSON object.\nThe Content-Type and Accept headers are set to application/json\n(if not specified).\n\n\n\n.IP \"\\fB\\,--form\\/\\fR, \\fB\\,-f\\/\\fR\"\n\n\nData items from the command line are serialized as form fields.\n\nThe Content-Type is set to application/x-www-form-urlencoded (if not\nspecified). The presence of any file fields results in a\nmultipart/form-data request.\n\n\n\n.IP \"\\fB\\,--multipart\\/\\fR\"\n\n\nSimilar to \\fB\\,--form\\/\\fR, but always sends a multipart/form-data request (i.e., even without files).\n\n\n.IP \"\\fB\\,--boundary\\/\\fR\"\n\n\nSpecify a custom boundary string for multipart/form-data requests. Only has effect only together with \\fB\\,--form\\/\\fR.\n\n\n.IP \"\\fB\\,--raw\\/\\fR\"\n\n\nThis option allows you to pass raw request data without extra processing\n(as opposed to the structured request items syntax):\n\n $ http \\fB\\,--raw\\/\\fR=\\[aq]data\\[aq] pie.dev/post\n\nYou can achieve the same by piping the data via stdin:\n\n $ echo data | http pie.dev/post\n\nOr have HTTPie load the raw data from a file:\n\n $ http pie.dev/post @data.txt\n\n\n\n\n.PP\n.SH Content processing options\n.IP \"\\fB\\,--compress\\/\\fR, \\fB\\,-x\\/\\fR\"\n\n\nContent compressed (encoded) with Deflate algorithm.\nThe Content-Encoding header is set to deflate.\n\nCompression is skipped if it appears that compression ratio is\nnegative. Compression can be forced by repeating the argument.\n\n\n\n.PP\n.SH Output processing\n.IP \"\\fB\\,--pretty\\/\\fR\"\n\n\nControls output processing. The value can be \\[dq]none\\[dq] to not prettify\nthe output (default for redirected output), \\[dq]all\\[dq] to apply both colors\nand formatting (default for terminal output), \\[dq]colors\\[dq], or \\[dq]format\\[dq].\n\n\n\n.IP \"\\fB\\,--style\\/\\fR, \\fB\\,-s\\/\\fR \\fI\\,STYLE\\/\\fR\"\n\n\nOutput coloring style (default is \\[dq]auto\\[dq]). It can be one of:\n\n auto, pie, pie-dark, pie-light, solarized\n\n\nFor finding out all available styles in your system, try:\n\n$ http \\fB\\,--style\\/\\fR\n\nThe \\[dq]auto\\[dq] style follows your terminal\\[aq]s ANSI color styles.\nFor non-auto styles to work properly, please make sure that the\n$TERM environment variable is set to \\[dq]xterm-256color\\[dq] or similar\n(e.g., via `export TERM=xterm-256color\\[aq] in your \\(ti/.bashrc).\n\n.IP \"\\fB\\,--unsorted\\/\\fR\"\n\n\nDisables all sorting while formatting output. It is a shortcut for:\n\n \\fB\\,--format-options\\/\\fR=headers.sort:false,json.sort_keys:false\n\n\n\n.IP \"\\fB\\,--sorted\\/\\fR\"\n\n\nRe-enables all sorting options while formatting output. It is a shortcut for:\n\n \\fB\\,--format-options\\/\\fR=headers.sort:true,json.sort_keys:true\n\n\n\n.IP \"\\fB\\,--response-charset\\/\\fR \\fI\\,ENCODING\\/\\fR\"\n\n\nOverride the response encoding for terminal display purposes, e.g.:\n\n \\fB\\,--response-charset\\/\\fR=utf8\n \\fB\\,--response-charset\\/\\fR=big5\n\n\n\n.IP \"\\fB\\,--response-mime\\/\\fR \\fI\\,MIME_TYPE\\/\\fR\"\n\n\nOverride the response mime type for coloring and formatting for the terminal, e.g.:\n\n \\fB\\,--response-mime\\/\\fR=application/json\n \\fB\\,--response-mime\\/\\fR=text/xml\n\n\n\n.IP \"\\fB\\,--format-options\\/\\fR\"\n\n\nControls output formatting. Only relevant when formatting is enabled\nthrough (explicit or implied) \\fB\\,--pretty\\/\\fR=all or \\fB\\,--pretty\\/\\fR=format.\nThe following are the default options:\n\n headers.sort:true\n json.format:true\n json.indent:4\n json.sort_keys:true\n xml.format:true\n xml.indent:2\n\nYou may use this option multiple times, as well as specify multiple\ncomma-separated options at the same time. For example, this modifies the\nsettings to disable the sorting of JSON keys, and sets the indent size to 2:\n\n \\fB\\,--format-options\\/\\fR json.sort_keys:false,json.indent:2\n\nThis is something you will typically put into your config file.\n\n\n\n.PP\n.SH Output options\n.IP \"\\fB\\,--print\\/\\fR, \\fB\\,-p\\/\\fR \\fI\\,WHAT\\/\\fR\"\n\n\nString specifying what the output should contain:\n\n \\[aq]H\\[aq] request headers\n \\[aq]B\\[aq] request body\n \\[aq]h\\[aq] response headers\n \\[aq]b\\[aq] response body\n \\[aq]m\\[aq] response metadata\n\nThe default behaviour is \\[aq]hb\\[aq] (i.e., the response\nheaders and body is printed), if standard output is not redirected.\nIf the output is piped to another program or to a file, then only the\nresponse body is printed by default.\n\n\n\n.IP \"\\fB\\,--headers\\/\\fR, \\fB\\,-h\\/\\fR\"\n\n\nPrint only the response headers. Shortcut for \\fB\\,--print\\/\\fR=h.\n\n\n\n.IP \"\\fB\\,--meta\\/\\fR, \\fB\\,-m\\/\\fR\"\n\n\nPrint only the response metadata. Shortcut for \\fB\\,--print\\/\\fR=m.\n\n\n\n.IP \"\\fB\\,--body\\/\\fR, \\fB\\,-b\\/\\fR\"\n\n\nPrint only the response body. Shortcut for \\fB\\,--print\\/\\fR=b.\n\n\n\n.IP \"\\fB\\,--verbose\\/\\fR, \\fB\\,-v\\/\\fR\"\n\n\nVerbose output. For the level one (with single `\\fB\\,-v\\/\\fR`/`\\fB\\,--verbose\\/\\fR`), print\nthe whole request as well as the response. Also print any intermediary\nrequests/responses (such as redirects). For the second level and higher,\nprint these as well as the response metadata.\n\nLevel one is a shortcut for: \\fB\\,--all\\/\\fR \\fB\\,--print\\/\\fR=BHbh\nLevel two is a shortcut for: \\fB\\,--all\\/\\fR \\fB\\,--print\\/\\fR=BHbhm\n\n\n.IP \"\\fB\\,--all\\/\\fR\"\n\n\nBy default, only the final request/response is shown. Use this flag to show\nany intermediary requests/responses as well. Intermediary requests include\nfollowed redirects (with \\fB\\,--follow\\/\\fR), the first unauthorized request when\nDigest auth is used (\\fB\\,--auth\\/\\fR=digest), etc.\n\n\n\n.IP \"\\fB\\,--stream\\/\\fR, \\fB\\,-S\\/\\fR\"\n\n\nAlways stream the response body by line, i.e., behave like `tail \\fB\\,-f\\/\\fR\\[aq].\n\nWithout \\fB\\,--stream\\/\\fR and with \\fB\\,--pretty\\/\\fR (either set or implied),\nHTTPie fetches the whole response before it outputs the processed data.\n\nSet this option when you want to continuously display a prettified\nlong-lived response, such as one from the Twitter streaming API.\n\nIt is useful also without \\fB\\,--pretty\\/\\fR: It ensures that the output is flushed\nmore often and in smaller chunks.\n\n\n\n.IP \"\\fB\\,--output\\/\\fR, \\fB\\,-o\\/\\fR \\fI\\,FILE\\/\\fR\"\n\n\nSave output to FILE instead of stdout. If \\fB\\,--download\\/\\fR is also set, then only\nthe response body is saved to FILE. Other parts of the HTTP exchange are\nprinted to stderr.\n\n\n\n.IP \"\\fB\\,--download\\/\\fR, \\fB\\,-d\\/\\fR\"\n\n\nDo not print the response body to stdout. Rather, download it and store it\nin a file. The filename is guessed unless specified with \\fB\\,--output\\/\\fR\n[filename]. This action is similar to the default behaviour of wget.\n\n\n\n.IP \"\\fB\\,--continue\\/\\fR, \\fB\\,-c\\/\\fR\"\n\n\nResume an interrupted download. Note that the \\fB\\,--output\\/\\fR option needs to be\nspecified as well.\n\n\n\n.IP \"\\fB\\,--quiet\\/\\fR, \\fB\\,-q\\/\\fR\"\n\n\nDo not print to stdout or stderr, except for errors and warnings when provided once.\nProvide twice to suppress warnings as well.\nstdout is still redirected if \\fB\\,--output\\/\\fR is specified.\nFlag doesn\\[aq]t affect behaviour of download beyond not printing to terminal.\n\n\n\n.PP\n.SH Sessions\n.IP \"\\fB\\,--session\\/\\fR \\fI\\,SESSION_NAME_OR_PATH\\/\\fR\"\n\n\nCreate, or reuse and update a session. Within a session, custom headers,\nauth credential, as well as any cookies sent by the server persist between\nrequests.\n\nSession files are stored in:\n\n [HTTPIE_CONFIG_DIR]//.json.\n\nSee the following page to find out your default HTTPIE_CONFIG_DIR:\n\n https://httpie.io/docs/cli/config-file-directory\n\n\n.IP \"\\fB\\,--session-read-only\\/\\fR \\fI\\,SESSION_NAME_OR_PATH\\/\\fR\"\n\n\nCreate or read a session without updating it form the request/response\nexchange.\n\n\n\n.PP\n.SH Authentication\n.IP \"\\fB\\,--auth\\/\\fR, \\fB\\,-a\\/\\fR \\fI\\,USER[:PASS] | TOKEN\\/\\fR\"\n\n\nFor username/password based authentication mechanisms (e.g\nbasic auth or digest auth) if only the username is provided\n(\\fB\\,-a\\/\\fR username), HTTPie will prompt for the password.\n\n\n\n.IP \"\\fB\\,--auth-type\\/\\fR, \\fB\\,-A\\/\\fR\"\n\n\nThe authentication mechanism to be used. Defaults to \\[dq]basic\\[dq].\n\n\\[dq]basic\\[dq]: Basic HTTP auth\n\n\\[dq]digest\\[dq]: Digest HTTP auth\n\n\\[dq]bearer\\[dq]: Bearer HTTP Auth\n\nTo see all available auth types on your system, including ones installed via plugins, run:\n\n$ http \\fB\\,--auth-type\\/\\fR\n\n.IP \"\\fB\\,--ignore-netrc\\/\\fR\"\n\n\nIgnore credentials from .netrc.\n\n\n.PP\n.SH Network\n.IP \"\\fB\\,--offline\\/\\fR\"\n\n\nBuild the request and print it but don\\(gat actually send it.\n\n\n.IP \"\\fB\\,--proxy\\/\\fR \\fI\\,PROTOCOL:PROXY_URL\\/\\fR\"\n\n\nString mapping protocol to the URL of the proxy\n(e.g. http:http://foo.bar:3128). You can specify multiple proxies with\ndifferent protocols. The environment variables $ALL_PROXY, $HTTP_PROXY,\nand $HTTPS_proxy are supported as well.\n\n\n\n.IP \"\\fB\\,--follow\\/\\fR, \\fB\\,-F\\/\\fR\"\n\n\nFollow 30x Location redirects.\n\n\n.IP \"\\fB\\,--max-redirects\\/\\fR\"\n\n\nBy default, requests have a limit of 30 redirects (works with \\fB\\,--follow\\/\\fR).\n\n\n\n.IP \"\\fB\\,--max-headers\\/\\fR\"\n\n\nThe maximum number of response headers to be read before giving up (default 0, i.e., no limit).\n\n\n.IP \"\\fB\\,--timeout\\/\\fR \\fI\\,SECONDS\\/\\fR\"\n\n\nThe connection timeout of the request in seconds.\nThe default value is 0, i.e., there is no timeout limit.\nThis is not a time limit on the entire response download;\nrather, an error is reported if the server has not issued a response for\ntimeout seconds (more precisely, if no bytes have been received on\nthe underlying socket for timeout seconds).\n\n\n\n.IP \"\\fB\\,--check-status\\/\\fR\"\n\n\nBy default, HTTPie exits with 0 when no network or other fatal errors\noccur. This flag instructs HTTPie to also check the HTTP status code and\nexit with an error if the status indicates one.\n\nWhen the server replies with a 4xx (Client Error) or 5xx (Server Error)\nstatus code, HTTPie exits with 4 or 5 respectively. If the response is a\n3xx (Redirect) and \\fB\\,--follow\\/\\fR hasn\\[aq]t been set, then the exit status is 3.\nAlso an error message is written to stderr if stdout is redirected.\n\n\n\n.IP \"\\fB\\,--path-as-is\\/\\fR\"\n\n\nBypass dot segment (/../ or /./) URL squashing.\n\n\n.IP \"\\fB\\,--chunked\\/\\fR\"\n\n\nEnable streaming via chunked transfer encoding. The Transfer-Encoding header is set to chunked.\n\n\n.PP\n.SH SSL\n.IP \"\\fB\\,--verify\\/\\fR\"\n\n\nSet to \\[dq]no\\[dq] (or \\[dq]false\\[dq]) to skip checking the host\\[aq]s SSL certificate.\nDefaults to \\[dq]yes\\[dq] (\\[dq]true\\[dq]). You can also pass the path to a CA_BUNDLE file\nfor private certs. (Or you can set the REQUESTS_CA_BUNDLE environment\nvariable instead.)\n\n\n.IP \"\\fB\\,--ssl\\/\\fR\"\n\n\nThe desired protocol version to use. This will default to\nSSL v2.3 which will negotiate the highest protocol that both\nthe server and your installation of OpenSSL support. Available protocols\nmay vary depending on OpenSSL installation (only the supported ones\nare shown here).\n\n\n\n.IP \"\\fB\\,--ciphers\\/\\fR\"\n\n\n\nA string in the OpenSSL cipher list format.\n\n\nSee `http \\fB\\,--help\\/\\fR` for the default ciphers list on you system.\n\n\n\n\n\n.IP \"\\fB\\,--cert\\/\\fR\"\n\n\nYou can specify a local cert to use as client side SSL certificate.\nThis file may either contain both private key and certificate or you may\nspecify \\fB\\,--cert-key\\/\\fR separately.\n\n\n\n.IP \"\\fB\\,--cert-key\\/\\fR\"\n\n\nThe private key to use with SSL. Only needed if \\fB\\,--cert\\/\\fR is given and the\ncertificate file does not contain the private key.\n\n\n\n.IP \"\\fB\\,--cert-key-pass\\/\\fR\"\n\n\nThe passphrase to be used to with the given private key. Only needed if \\fB\\,--cert-key\\/\\fR\nis given and the key file requires a passphrase.\nIf not provided, you\\(gall be prompted interactively.\n\n\n.PP\n.SH Troubleshooting\n.IP \"\\fB\\,--ignore-stdin\\/\\fR, \\fB\\,-I\\/\\fR\"\n\n\nDo not attempt to read stdin\n\n\n.IP \"\\fB\\,--help\\/\\fR\"\n\n\nShow this help message and exit.\n\n\n.IP \"\\fB\\,--manual\\/\\fR\"\n\n\nShow the full manual.\n\n\n.IP \"\\fB\\,--version\\/\\fR\"\n\n\nShow version and exit.\n\n\n.IP \"\\fB\\,--traceback\\/\\fR\"\n\n\nPrints the exception traceback should one occur.\n\n\n.IP \"\\fB\\,--default-scheme\\/\\fR\"\n\n\nThe default scheme to use if not specified in the URL.\n\n\n.IP \"\\fB\\,--debug\\/\\fR\"\n\n\nPrints the exception traceback should one occur, as well as other\ninformation useful for debugging HTTPie itself and for reporting bugs.\n\n\n\n.PP\n.SH SEE ALSO\n\nFor every \\fB\\,--OPTION\\/\\fR there is also a \\fB\\,--no-OPTION\\/\\fR that reverts OPTION\nto its default value.\n\nSuggestions and bug reports are greatly appreciated:\nhttps://github.com/httpie/cli/issues" }, { "path": "extras/packaging/linux/Dockerfile", "content": "# Use the oldest (but still supported) Ubuntu as the base for PyInstaller\n# packages. This will prevent stuff like glibc from conflicting.\nFROM ubuntu:18.04\n\nRUN apt-get update\nRUN apt-get install -y software-properties-common binutils\nRUN apt-get install -y ruby-dev\nRUN gem install fpm\n\n# Use deadsnakes for the latest Pythons (e.g 3.9)\nRUN add-apt-repository ppa:deadsnakes/ppa\nRUN apt-get update && apt-get install -y python3.9 python3.9-dev python3.9-venv\n\n# Install rpm as well, since we are going to build fedora dists too\nRUN apt-get install -y rpm\n\nADD . /app\nWORKDIR /app/extras/packaging/linux\n\nENV VIRTUAL_ENV=/opt/venv\nRUN python3.9 -m venv $VIRTUAL_ENV\nENV PATH=\"$VIRTUAL_ENV/bin:$PATH\"\n\n# Ensure that pip is renewed, otherwise we would be using distro-provided pip\n# which strips vendored packages and doesn't work with PyInstaller.\nRUN python -m pip install /app\nRUN python -m pip install pyinstaller wheel\nRUN python -m pip install --force-reinstall --upgrade pip\n\nRUN echo 'BUILD_CHANNEL=\"pypi\"' > /app/httpie/internal/__build_channel__.py\nRUN python build.py\n\nENTRYPOINT [\"mv\", \"/app/extras/packaging/linux/dist/\", \"/artifacts\"]\n" }, { "path": "extras/packaging/linux/README.md", "content": "# Standalone Linux Packages\n\n![packaging.png](https://user-images.githubusercontent.com/47358913/159950478-2d090d1b-69b9-4914-a1b4-d3e3d8e25fe0.png)\n\nThis directory contains the build scripts for creating:\n\n- A self-contained binary executable for the HTTPie itself\n- `httpie.deb` and `httpie.rpm` packages for Debian and Fedora.\n\nThe process of constructing them are fully automated, and can be easily done through the [`Release as Standalone Linux Package`](https://github.com/httpie/cli/actions/workflows/release-linux-standalone.yml)\naction. Once it finishes, the release artifacts will be attached in the summary page of the triggered run.\n\n\n## Hacking\n\nThe main entry point for the package builder is the [`build.py`](https://github.com/httpie/cli/blob/master/extras/packaging/linux/build.py). It\ncontains 2 major methods:\n\n- `build_binaries`, for the self-contained executables\n- `build_packages`, for the OS-specific packages (which wrap the binaries)\n\n### `build_binaries`\n\nWe use [PyInstaller](https://pyinstaller.readthedocs.io/en/stable/) for the binaries. Normally pyinstaller offers two different modes:\n\n- Single directory (harder to distribute, low redundancy. Library files are shared across different executables)\n- Single binary (easier to distribute, higher redundancy. Same libraries are statically linked to different executables, so higher total size)\n\nSince our binary size (in total 20 MiBs) is not that big, we have decided to choose the single binary mode for the sake of easier distribution.\n\nWe also disable `UPX`, which is a runtime decompression method since it adds some startup cost.\n\n### `build_packages`\n\nWe build our OS-specific packages with [FPM](https://github.com/jordansissel/fpm) which offers a really nice abstraction. We use the `dir` mode,\nand package `http`, `https` and `httpie` commands. More can be added to the `files` option.\n\nSince the `httpie` depends on having a pip executable, we explicitly depend on the system Python even though the core does not use it.\n\n### Docker Image\n\nThis directory also contains a [docker image](https://github.com/httpie/cli/blob/master/extras/packaging/linux/Dockerfile) which helps\nbuilding our standalone binaries in an isolated environment with the lowest possible library versions. This is important, since even though\nthe executables are standalone they still depend on some main system C libraries (like `glibc`) so we need to create our executables inside\nan environment with a very old (but not deprecated) glibc version. It makes us soundproof for all active Ubuntu/Debian versions.\n\nIt also contains the Python version we package our HTTPie with, so it is the place if you need to change it.\n\n### `./get_release_artifacts.sh`\n\nIf you make a change in the `build.py`, run the following script to test it out. It will return multiple files under `artifacts/dist` which\nthen you can test out and ensure their quality (it is also the script that we use in our automation).\n" }, { "path": "extras/packaging/linux/build.py", "content": "import stat\nimport subprocess\nfrom pathlib import Path\nfrom typing import Iterator, Tuple\n\nBUILD_DIR = Path(__file__).parent\nHTTPIE_DIR = BUILD_DIR.parent.parent.parent\n\nEXTRAS_DIR = HTTPIE_DIR / 'extras'\nMAN_PAGES_DIR = EXTRAS_DIR / 'man'\n\nSCRIPT_DIR = BUILD_DIR / Path('scripts')\nHOOKS_DIR = SCRIPT_DIR / 'hooks'\n\nDIST_DIR = BUILD_DIR / 'dist'\n\nTARGET_SCRIPTS = {\n SCRIPT_DIR / 'http_cli.py': [],\n SCRIPT_DIR / 'httpie_cli.py': ['--hidden-import=pip'],\n}\n\n\ndef build_binaries() -> Iterator[Tuple[str, Path]]:\n for target_script, extra_args in TARGET_SCRIPTS.items():\n subprocess.check_call(\n [\n 'pyinstaller',\n '--onefile',\n '--noupx',\n '-p',\n HTTPIE_DIR,\n '--additional-hooks-dir',\n HOOKS_DIR,\n *extra_args,\n target_script,\n ]\n )\n\n for executable_path in DIST_DIR.iterdir():\n if executable_path.suffix:\n continue\n stat_r = executable_path.stat()\n executable_path.chmod(stat_r.st_mode | stat.S_IEXEC)\n yield executable_path.stem, executable_path\n\n\ndef build_packages(http_binary: Path, httpie_binary: Path) -> None:\n import httpie\n\n # Mapping of src_file -> dst_file\n files = [\n (http_binary, '/usr/bin/http'),\n (http_binary, '/usr/bin/https'),\n (httpie_binary, '/usr/bin/httpie'),\n ]\n files.extend(\n (man_page, f'/usr/share/man/man1/{man_page.name}')\n for man_page in MAN_PAGES_DIR.glob('*.1')\n )\n\n # A list of additional dependencies\n deps = [\n 'python3 >= 3.7',\n 'python3-pip'\n ]\n\n processed_deps = [\n f'--depends={dep}'\n for dep in deps\n ]\n processed_files = [\n '='.join([str(src.resolve()), dst]) for src, dst in files\n ]\n for target in ['deb', 'rpm']:\n subprocess.check_call(\n [\n 'fpm',\n '--force',\n '-s',\n 'dir',\n '-t',\n target,\n '--name',\n 'httpie',\n '--version',\n httpie.__version__,\n '--description',\n httpie.__doc__.strip(),\n '--license',\n httpie.__licence__,\n *processed_deps,\n *processed_files,\n ],\n cwd=DIST_DIR,\n )\n\n\ndef main():\n binaries = dict(build_binaries())\n build_packages(binaries['http_cli'], binaries['httpie_cli'])\n\n # Rename http_cli/httpie_cli to http/httpie\n binaries['http_cli'].rename(DIST_DIR / 'http')\n binaries['httpie_cli'].rename(DIST_DIR / 'httpie')\n\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "extras/packaging/linux/get_release_artifacts.sh", "content": "#!/bin/bash\n\nset -xe\n\nREPO_ROOT=../../../\nARTIFACTS_DIR=$(pwd)/artifacts\n\n# Reset the ARTIFACTS_DIR.\nrm -rf $ARTIFACTS_DIR\nmkdir -p $ARTIFACTS_DIR\n\n# Operate on the repository root to have the proper\n# docker context.\npushd $REPO_ROOT\n\n# Build the PyInstaller image\ndocker build -t pyinstaller-httpie -f extras/packaging/linux/Dockerfile .\n\n# Copy the artifacts to the designated directory.\ndocker run --rm -i -v $ARTIFACTS_DIR:/artifacts pyinstaller-httpie:latest\n\npopd\n" }, { "path": "extras/packaging/linux/scripts/hooks/hook-pip.py", "content": "from pathlib import Path\nfrom PyInstaller.utils.hooks import collect_all\n\ndef hook(hook_api):\n for pkg in [\n 'pip',\n 'setuptools',\n 'distutils',\n 'pkg_resources'\n ]:\n datas, binaries, hiddenimports = collect_all(pkg)\n hook_api.add_datas(datas)\n hook_api.add_binaries(binaries)\n hook_api.add_imports(*hiddenimports)\n" }, { "path": "extras/packaging/linux/scripts/http_cli.py", "content": "from httpie.__main__ import main\n\nif __name__ == '__main__':\n import sys\n sys.exit(main())\n" }, { "path": "extras/packaging/linux/scripts/httpie_cli.py", "content": "from httpie.manager.__main__ import main\n\nif __name__ == '__main__':\n import sys\n sys.exit(main())\n" }, { "path": "extras/profiling/README.md", "content": "# HTTPie Benchmarking Infrastructure\n\nThis directory includes the benchmarks we use for testing HTTPie's speed and the\ninfrastructure to automate this testing across versions.\n\n## Usage\n\nEnsure the following requirements are satisfied:\n\n- Python 3.7+\n- `pyperf`\n\nThen, run the `extras/profiling/run.py`:\n\n```console\n$ python extras/profiling/run.py\n```\n\nWithout any options, this command will initially create an isolated environment\nand install `httpie` from the latest commit. Then it will create a second\nenvironment with the `master` of the current repository and run the benchmarks\non both of them. It will compare the results and print it as a markdown table:\n\n| Benchmark | master | this_branch |\n| -------------------------------------- | :----: | :------------------: |\n| `http --version` (startup) | 201 ms | 174 ms: 1.16x faster |\n| `http --offline pie.dev/get` (startup) | 200 ms | 174 ms: 1.15x faster |\n| Geometric mean | (ref) | 1.10x faster |\n\nIf your `master` branch is not up-to-date, you can get a fresh clone by passing\n`--fresh` option. This way, the benchmark runner will clone the `httpie/cli`\nrepo from `GitHub` and use it as the baseline.\n\nYou can customize these branches by passing `--local-repo`/`--target-branch`,\nand customize the repos by passing `--local-repo`/`--target-repo` (can either\ntake a URL or a path).\n\nIf you want to run a third environment with additional dependencies (such as\n`pyOpenSSL`), you can pass `--complex`.\n" }, { "path": "extras/profiling/benchmarks.py", "content": "\"\"\"\nThis file is the declaration of benchmarks for HTTPie. It\nis also used to run them with the current environment.\n\nEach instance of BaseRunner class will be an individual\nbenchmark. And if run without any arguments, this file\nwill execute every benchmark instance and report the\ntimings.\n\nThe benchmarks are run through 'pyperf', which allows to\ndo get very precise results. For micro-benchmarks like startup,\nplease run `pyperf system tune` to get even more accurate results.\n\nExamples:\n\n # Run everything as usual, the default is that we do 3 warm-up runs\n # and 5 actual runs.\n $ python extras/profiling/benchmarks.py\n\n # For retrieving results faster, pass --fast\n $ python extras/profiling/benchmarks.py --fast\n\n # For verify everything works as expected, pass --debug-single-value.\n # It will only run everything once, so the resuls are not reliable. But\n # very useful when iterating on a benchmark\n $ python extras/profiling/benchmarks.py --debug-single-value\n\n # If you want to run with a custom HTTPie command (for example with\n # and HTTPie instance installed in another virtual environment),\n # pass HTTPIE_COMMAND variable.\n $ HTTPIE_COMMAND=\"/my/python /my/httpie\" python extras/profiling/benchmarks.py\n\"\"\"\n\nfrom __future__ import annotations\n\nimport os\nimport shlex\nimport subprocess\nimport sys\nimport threading\nfrom contextlib import ExitStack, contextmanager\nfrom dataclasses import dataclass, field\nfrom functools import cached_property, partial\nfrom http.server import HTTPServer, SimpleHTTPRequestHandler\nfrom tempfile import TemporaryDirectory\nfrom typing import ClassVar, Final, List\n\nimport pyperf\n\n# For download benchmarks, define a set of files.\n# file: (block_size, count) => total_size = block_size * count\nPREDEFINED_FILES: Final = {'3G': (3 * 1024 ** 2, 1024)}\n\n\nclass QuietSimpleHTTPServer(SimpleHTTPRequestHandler):\n def log_message(self, *args, **kwargs):\n pass\n\n\n@contextmanager\ndef start_server():\n \"\"\"Create a server to serve local files. It will create the\n PREDEFINED_FILES through dd.\"\"\"\n with TemporaryDirectory() as directory:\n for file_name, (block_size, count) in PREDEFINED_FILES.items():\n subprocess.check_call(\n [\n 'dd',\n 'if=/dev/zero',\n f'of={file_name}',\n f'bs={block_size}',\n f'count={count}',\n ],\n cwd=directory,\n stdout=subprocess.DEVNULL,\n stderr=subprocess.DEVNULL,\n )\n\n handler = partial(QuietSimpleHTTPServer, directory=directory)\n server = HTTPServer(('localhost', 0), handler)\n\n thread = threading.Thread(target=server.serve_forever)\n thread.start()\n yield '{}:{}'.format(*server.socket.getsockname())\n server.shutdown()\n thread.join(timeout=0.5)\n\n\n@dataclass\nclass Context:\n benchmarks: ClassVar[List[BaseRunner]] = []\n stack: ExitStack = field(default_factory=ExitStack)\n runner: pyperf.Runner = field(default_factory=pyperf.Runner)\n\n def run(self) -> pyperf.BenchmarkSuite:\n results = [benchmark.run(self) for benchmark in self.benchmarks]\n return pyperf.BenchmarkSuite(results)\n\n @property\n def cmd(self) -> List[str]:\n if cmd := os.getenv('HTTPIE_COMMAND'):\n return shlex.split(cmd)\n\n http = os.path.join(os.path.dirname(sys.executable), 'http')\n assert os.path.exists(http)\n return [sys.executable, http]\n\n @cached_property\n def server(self) -> str:\n return self.stack.enter_context(start_server())\n\n def __enter__(self):\n return self\n\n def __exit__(self, *exc_info):\n self.stack.close()\n\n\n@dataclass\nclass BaseRunner:\n \"\"\"\n An individual benchmark case. By default it has the category\n (e.g like startup or download) and a name.\n \"\"\"\n\n category: str\n title: str\n\n def __post_init__(self):\n Context.benchmarks.append(self)\n\n def run(self, context: Context) -> pyperf.Benchmark:\n raise NotImplementedError\n\n @property\n def name(self) -> str:\n return f'{self.title} ({self.category})'\n\n\n@dataclass\nclass CommandRunner(BaseRunner):\n \"\"\"\n Run a single command, and benchmark it.\n \"\"\"\n\n args: List[str]\n\n def run(self, context: Context) -> pyperf.Benchmark:\n return context.runner.bench_command(self.name, [*context.cmd, *self.args])\n\n\n@dataclass\nclass DownloadRunner(BaseRunner):\n \"\"\"\n Benchmark downloading a single file from the\n remote server.\n \"\"\"\n\n file_name: str\n\n def run(self, context: Context) -> pyperf.Benchmark:\n return context.runner.bench_command(\n self.name,\n [\n *context.cmd,\n '--download',\n 'GET',\n f'{context.server}/{self.file_name}',\n ],\n )\n\n\nCommandRunner('startup', '`http --version`', ['--version'])\nCommandRunner('startup', '`http --offline pie.dev/get`', ['--offline', 'pie.dev/get'])\nfor pretty in ['all', 'none']:\n CommandRunner(\n 'startup',\n f'`http --pretty={pretty} pie.dev/stream/1000`',\n [\n '--print=HBhb',\n f'--pretty={pretty}',\n 'httpbin.org/stream/1000'\n ]\n )\nDownloadRunner('download', '`http --download :/big_file.txt` (3GB)', '3G')\n\n\ndef main() -> None:\n # PyPerf will bring it's own argument parser, so configure the script.\n # The somewhat fast and also precise enough configuration is this. We run\n # benchmarks 3 times to warm up (e.g especially for download benchmark, this\n # is important). And then 5 actual runs where we record.\n sys.argv.extend(\n ['--worker', '--loops=1', '--warmup=3', '--values=5', '--processes=2']\n )\n\n with Context() as context:\n context.run()\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "extras/profiling/run.py", "content": "\"\"\"\nRun the HTTPie benchmark suite with multiple environments.\n\nThis script is configured in a way that, it will create\ntwo (or more) isolated environments and compare the *last\ncommit* of this repository with it's master.\n\n> If you didn't commit yet, it won't be showing results.\n\nYou can also pass --fresh, which would test the *last\ncommit* of this repository with a fresh copy of HTTPie\nitself. This way even if you don't have an up-to-date\nmaster branch, you can still compare it with the upstream's\nmaster.\n\nYou can also pass --complex to add 2 additional environments,\nwhich would include additional dependencies like pyOpenSSL.\n\nExamples:\n\n # Run everything as usual, and compare last commit with master\n $ python extras/profiling/run.py\n\n # Include complex environments\n $ python extras/profiling/run.py --complex\n\n # Compare against a fresh copy\n $ python extras/profiling/run.py --fresh\n\n # Compare against a custom branch of a custom repo\n $ python extras/profiling/run.py --target-repo my_repo --target-branch my_branch\n\n # Debug changes made on this script (only run benchmarks once)\n $ python extras/profiling/run.py --debug\n\"\"\"\n\nimport dataclasses\nimport shlex\nimport subprocess\nimport sys\nimport tempfile\nimport venv\nfrom argparse import ArgumentParser, FileType\nfrom contextlib import contextmanager\nfrom dataclasses import dataclass\nfrom pathlib import Path\nfrom typing import (IO, Dict, Generator, Iterable, List, Optional,\n Tuple)\n\nBENCHMARK_SCRIPT = Path(__file__).parent / 'benchmarks.py'\nCURRENT_REPO = Path(__file__).parent.parent.parent\n\nGITHUB_URL = 'https://github.com/httpie/cli.git'\nTARGET_BRANCH = 'master'\n\n# Additional dependencies for --complex\nADDITIONAL_DEPS = ('pyOpenSSL',)\n\n\ndef call(*args, **kwargs):\n kwargs.setdefault('stdout', subprocess.DEVNULL)\n return subprocess.check_call(*args, **kwargs)\n\n\nclass Environment:\n \"\"\"\n Each environment defines how to create an isolated instance\n where we could install HTTPie and run benchmarks without any\n environmental factors.\n \"\"\"\n\n @contextmanager\n def on_repo(self) -> Generator[Tuple[Path, Dict[str, str]], None, None]:\n \"\"\"\n Return the path to the python interpreter and the\n environment variables (e.g HTTPIE_COMMAND) to be\n used on the benchmarks.\n \"\"\"\n raise NotImplementedError\n\n\n@dataclass\nclass HTTPieEnvironment(Environment):\n repo_url: str\n branch: Optional[str] = None\n dependencies: Iterable[str] = ()\n\n @contextmanager\n def on_repo(self) -> Generator[Path, None, None]:\n with tempfile.TemporaryDirectory() as directory_path:\n directory = Path(directory_path)\n\n # Clone the repo\n repo_path = directory / 'httpie'\n call(\n ['git', 'clone', self.repo_url, repo_path],\n stderr=subprocess.DEVNULL,\n )\n\n if self.branch is not None:\n call(\n ['git', 'checkout', self.branch],\n cwd=repo_path,\n stderr=subprocess.DEVNULL,\n )\n\n # Prepare the environment\n venv_path = directory / '.venv'\n venv.create(venv_path, with_pip=True)\n\n # Install basic dependencies\n python = venv_path / 'bin' / 'python'\n call(\n [\n python,\n '-m',\n 'pip',\n 'install',\n 'wheel',\n 'pyperf==2.3.0',\n *self.dependencies,\n ]\n )\n\n # Create a wheel distribution of HTTPie\n call([python, 'setup.py', 'bdist_wheel'], cwd=repo_path)\n\n # Install httpie\n distribution_path = next((repo_path / 'dist').iterdir())\n call(\n [python, '-m', 'pip', 'install', distribution_path],\n cwd=repo_path,\n )\n\n http = venv_path / 'bin' / 'http'\n yield python, {'HTTPIE_COMMAND': shlex.join([str(python), str(http)])}\n\n\n@dataclass\nclass LocalCommandEnvironment(Environment):\n local_command: str\n\n @contextmanager\n def on_repo(self) -> Generator[Path, None, None]:\n yield sys.executable, {'HTTPIE_COMMAND': self.local_command}\n\n\ndef dump_results(\n results: List[str],\n file: IO[str],\n min_speed: Optional[str] = None\n) -> None:\n for result in results:\n lines = result.strip().splitlines()\n if min_speed is not None and \"hidden\" in lines[-1]:\n lines[-1] = (\n 'Some benchmarks were hidden from this list '\n 'because their timings did not change in a '\n 'significant way (change was within the error '\n 'margin ±{margin}%).'\n ).format(margin=min_speed)\n result = '\\n'.join(lines)\n\n print(result, file=file)\n print(\"\\n---\\n\", file=file)\n\n\ndef compare(*args, directory: Path, min_speed: Optional[str] = None):\n compare_args = ['pyperf', 'compare_to', '--table', '--table-format=md', *args]\n if min_speed:\n compare_args.extend(['--min-speed', min_speed])\n return subprocess.check_output(\n compare_args,\n cwd=directory,\n text=True,\n )\n\n\ndef run(\n configs: List[Dict[str, Environment]],\n file: IO[str],\n debug: bool = False,\n min_speed: Optional[str] = None,\n) -> None:\n result_directory = Path(tempfile.mkdtemp())\n results = []\n\n current = 1\n total = sum(1 for config in configs for _ in config.items())\n\n def iterate(env_name, status):\n print(\n f'Iteration: {env_name} ({current}/{total}) ({status})' + ' ' * 10,\n end='\\r',\n flush=True,\n )\n\n for config in configs:\n for env_name, env in config.items():\n iterate(env_name, 'setting up')\n with env.on_repo() as (python, env_vars):\n iterate(env_name, 'running benchmarks')\n args = [python, BENCHMARK_SCRIPT, '-o', env_name]\n if debug:\n args.append('--debug-single-value')\n call(\n args,\n cwd=result_directory,\n env=env_vars,\n )\n current += 1\n\n results.append(compare(\n *config.keys(),\n directory=result_directory,\n min_speed=min_speed\n ))\n\n dump_results(results, file=file, min_speed=min_speed)\n print('Results are available at:', result_directory)\n\n\ndef main() -> None:\n parser = ArgumentParser()\n parser.add_argument('--local-repo', default=CURRENT_REPO)\n parser.add_argument('--local-branch', default=None)\n parser.add_argument('--target-repo', default=CURRENT_REPO)\n parser.add_argument('--target-branch', default=TARGET_BRANCH)\n parser.add_argument(\n '--fresh',\n action='store_const',\n const=GITHUB_URL,\n dest='target_repo',\n help='Clone the target repo from upstream GitHub URL',\n )\n parser.add_argument(\n '--complex',\n action='store_true',\n help='Add a second run, with a complex python environment.',\n )\n parser.add_argument(\n '--local-bin',\n help='Run the suite with the given local binary in addition to'\n ' existing runners. (E.g --local-bin $(command -v xh))',\n )\n parser.add_argument(\n '--file',\n type=FileType('w'),\n default=sys.stdout,\n help='File to print the actual results',\n )\n parser.add_argument(\n '--min-speed',\n help='Minimum of speed in percent to consider that a '\n 'benchmark is significant'\n )\n parser.add_argument(\n '--debug',\n action='store_true',\n )\n\n options = parser.parse_args()\n\n configs = []\n\n base_config = {\n options.target_branch: HTTPieEnvironment(options.target_repo, options.target_branch),\n 'this_branch': HTTPieEnvironment(options.local_repo, options.local_branch),\n }\n configs.append(base_config)\n\n if options.complex:\n complex_config = {\n env_name\n + '-complex': dataclasses.replace(env, dependencies=ADDITIONAL_DEPS)\n for env_name, env in base_config.items()\n }\n configs.append(complex_config)\n\n if options.local_bin:\n base_config['binary'] = LocalCommandEnvironment(options.local_bin)\n\n run(configs, file=options.file, debug=options.debug, min_speed=options.min_speed)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "extras/scripts/generate_man_pages.py", "content": "import os\nimport re\nfrom contextlib import contextmanager\nfrom pathlib import Path\nfrom typing import Optional, Iterator, Iterable\n\n\n# So that httpie.cli.definition can provide man-page-specific output. Must be set before importing httpie.\nos.environ['HTTPIE_BUILDING_MAN_PAGES'] = '1'\n\nimport httpie\nfrom httpie.cli.definition import options as core_options, IS_MAN_PAGE\nfrom httpie.cli.options import ParserSpec\nfrom httpie.manager.cli import options as manager_options\nfrom httpie.output.ui.rich_help import OptionsHighlighter, to_usage\nfrom httpie.output.ui.rich_utils import render_as_string\n\n\nassert IS_MAN_PAGE, 'CLI definition does not understand we’re building man pages'\n\n# Escape certain characters, so they are rendered properly on all terminals.\n# \nESCAPE_MAP = {\n '\"': '\\[dq]',\n \"'\": '\\[aq]',\n '~': '\\(ti',\n '’': \"\\(ga\",\n '\\\\': '\\e',\n}\nESCAPE_MAP = {ord(key): value for key, value in ESCAPE_MAP.items()}\n\nEXTRAS_DIR = Path(__file__).parent.parent\nMAN_PAGE_PATH = EXTRAS_DIR / 'man'\nPROJECT_ROOT = EXTRAS_DIR.parent\n\nOPTION_HIGHLIGHT_RE = re.compile(\n OptionsHighlighter.highlights[0]\n)\n\n\nclass ManPageBuilder:\n def __init__(self):\n self.source = []\n\n def title_line(\n self,\n full_name: str,\n program_name: str,\n program_version: str,\n last_edit_date: str,\n ) -> None:\n self.source.append(\n f'.TH {program_name} 1 \"{last_edit_date}\" '\n f'\"{full_name} {program_version}\" \"{full_name} Manual\"'\n )\n\n def set_name(self, program_name: str) -> None:\n with self.section('NAME'):\n self.write(program_name)\n\n def write(self, text: str, *, bold: bool = False) -> None:\n if bold:\n text = '.B ' + text\n self.source.append(text)\n\n def separate(self) -> None:\n self.source.append('.PP')\n\n def format_desc(self, desc: str) -> str:\n description = _escape_and_dedent(desc)\n description = OPTION_HIGHLIGHT_RE.sub(\n # Boldify the option part, but don't remove the prefix (start of the match).\n lambda match: match[1] + self.boldify(match['option']),\n description\n )\n return description\n\n def add_comment(self, comment: str) -> None:\n self.source.append(f'.\\\\\" {comment}')\n\n def add_options(self, options: Iterable[str], *, metavar: Optional[str] = None) -> None:\n text = \", \".join(map(self.boldify, options))\n if metavar:\n text += f' {self.underline(metavar)}'\n self.write(f'.IP \"{text}\"')\n\n def build(self) -> str:\n return '\\n'.join(self.source)\n\n @contextmanager\n def section(self, section_name: str) -> Iterator[None]:\n self.write(f'.SH {section_name}')\n self.in_section = True\n yield\n self.in_section = False\n\n def underline(self, text: str) -> str:\n return r'\\fI\\,{}\\/\\fR'.format(text)\n\n def boldify(self, text: str) -> str:\n return r'\\fB\\,{}\\/\\fR'.format(text)\n\n\ndef _escape_and_dedent(text: str) -> str:\n lines = []\n for should_act, line in enumerate(text.splitlines()):\n # Only dedent after the first line.\n if should_act:\n if line.startswith(' '):\n line = line[4:]\n\n lines.append(line)\n return '\\n'.join(lines).translate(ESCAPE_MAP)\n\n\ndef to_man_page(program_name: str, spec: ParserSpec, *, is_top_level_cmd: bool = False) -> str:\n builder = ManPageBuilder()\n builder.add_comment(\n f\"This file is auto-generated from the parser declaration \"\n + (f\"in {Path(spec.source_file).relative_to(PROJECT_ROOT)} \" if spec.source_file else \"\")\n + f\"by {Path(__file__).relative_to(PROJECT_ROOT)}.\"\n )\n\n builder.title_line(\n full_name='HTTPie',\n program_name=program_name,\n program_version=httpie.__version__,\n last_edit_date=httpie.__date__,\n )\n builder.set_name(program_name)\n\n with builder.section('SYNOPSIS'):\n # `http` and `https` are commands that can be directly used, so they can have\n # a valid usage. But `httpie` is a top-level command with multiple sub commands,\n # so for the synopsis we'll only reference the `httpie` name.\n if is_top_level_cmd:\n synopsis = program_name\n else:\n synopsis = render_as_string(to_usage(spec, program_name=program_name))\n builder.write(synopsis)\n\n with builder.section('DESCRIPTION'):\n builder.write(spec.description)\n if spec.man_page_hint:\n builder.write(spec.man_page_hint)\n\n for index, group in enumerate(spec.groups, 1):\n with builder.section(group.name):\n if group.description:\n builder.write(group.description)\n\n for argument in group.arguments:\n if argument.is_hidden:\n continue\n\n raw_arg = argument.serialize(isolation_mode=True)\n\n metavar = raw_arg.get('metavar')\n if raw_arg.get('is_positional'):\n # In case of positional arguments, metavar is always equal\n # to the list of options (e.g `METHOD`).\n metavar = None\n builder.add_options(raw_arg['options'], metavar=metavar)\n\n desc = builder.format_desc(raw_arg.get('description', ''))\n builder.write('\\n' + desc + '\\n')\n\n builder.separate()\n\n if spec.epilog:\n with builder.section('SEE ALSO'):\n builder.write(builder.format_desc(spec.epilog))\n\n return builder.build()\n\n\ndef main() -> None:\n for program_name, spec, config in [\n ('http', core_options, {}),\n ('https', core_options, {}),\n ('httpie', manager_options, {'is_top_level_cmd': True}),\n ]:\n with open((MAN_PAGE_PATH / program_name).with_suffix('.1'), 'w') as stream:\n stream.write(to_man_page(program_name, spec, **config))\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "httpie/__init__.py", "content": "\"\"\"\nHTTPie: modern, user-friendly command-line HTTP client for the API era.\n\n\"\"\"\n\n__version__ = '3.2.4'\n__date__ = '2024-11-01'\n__author__ = 'Jakub Roztocil'\n__licence__ = 'BSD'\n" }, { "path": "httpie/__main__.py", "content": "\"\"\"The main entry point. Invoke as `http' or `python -m httpie'.\n\n\"\"\"\n\n\ndef main():\n try:\n from httpie.core import main\n exit_status = main()\n except KeyboardInterrupt:\n from httpie.status import ExitStatus\n exit_status = ExitStatus.ERROR_CTRL_C\n\n return exit_status.value\n\n\nif __name__ == '__main__': # pragma: nocover\n import sys\n sys.exit(main())\n" }, { "path": "httpie/adapters.py", "content": "from httpie.cli.dicts import HTTPHeadersDict\nfrom requests.adapters import HTTPAdapter\n\n\nclass HTTPieHTTPAdapter(HTTPAdapter):\n\n def build_response(self, req, resp):\n \"\"\"Wrap the original headers with the `HTTPHeadersDict`\n to preserve multiple headers that have the same name\"\"\"\n\n response = super().build_response(req, resp)\n response.headers = HTTPHeadersDict(getattr(resp, 'headers', {}))\n return response\n" }, { "path": "httpie/cli/__init__.py", "content": "" }, { "path": "httpie/cli/argparser.py", "content": "import argparse\nimport errno\nimport os\nimport re\nimport sys\nfrom argparse import RawDescriptionHelpFormatter\nfrom textwrap import dedent\nfrom urllib.parse import urlsplit\n\nfrom requests.utils import get_netrc_auth\n\nfrom .argtypes import (\n AuthCredentials, SSLCredentials, KeyValueArgType,\n PARSED_DEFAULT_FORMAT_OPTIONS,\n parse_auth,\n parse_format_options,\n)\nfrom .constants import (\n HTTP_GET, HTTP_POST, BASE_OUTPUT_OPTIONS, OUTPUT_OPTIONS, OUTPUT_OPTIONS_DEFAULT,\n OUTPUT_OPTIONS_DEFAULT_OFFLINE, OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED,\n OUT_RESP_BODY, PRETTY_MAP, PRETTY_STDOUT_TTY_ONLY, RequestType,\n SEPARATOR_CREDENTIALS,\n SEPARATOR_GROUP_ALL_ITEMS, SEPARATOR_GROUP_DATA_ITEMS, URL_SCHEME_RE,\n)\nfrom .exceptions import ParseError\nfrom .requestitems import RequestItems\nfrom ..context import Environment\nfrom ..plugins.registry import plugin_manager\nfrom ..utils import ExplicitNullAuth, get_content_type\n\n\nclass HTTPieHelpFormatter(RawDescriptionHelpFormatter):\n \"\"\"A nicer help formatter.\n\n Help for arguments can be indented and contain new lines.\n It will be de-dented and arguments in the help\n will be separated by a blank line for better readability.\n\n\n \"\"\"\n\n def __init__(self, max_help_position=6, *args, **kwargs):\n # A smaller indent for args help.\n kwargs['max_help_position'] = max_help_position\n super().__init__(*args, **kwargs)\n\n def _split_lines(self, text, width):\n text = dedent(text).strip() + '\\n\\n'\n return text.splitlines()\n\n def add_usage(self, usage, actions, groups, prefix=None):\n # Only display the positional arguments\n displayed_actions = [\n action\n for action in actions\n if not action.option_strings\n ]\n\n _, exception, _ = sys.exc_info()\n if (\n isinstance(exception, argparse.ArgumentError)\n and len(exception.args) >= 1\n and isinstance(exception.args[0], argparse.Action)\n ):\n # add_usage path is also taken when you pass an invalid option,\n # e.g --style=invalid. If something like that happens, we want\n # to include to action that caused to the invalid usage into\n # the list of actions we are displaying.\n displayed_actions.insert(0, exception.args[0])\n\n super().add_usage(\n usage,\n displayed_actions,\n groups,\n prefix=\"usage:\\n \"\n )\n\n\n# TODO: refactor and design type-annotated data structures\n# for raw args + parsed args and keep things immutable.\nclass BaseHTTPieArgumentParser(argparse.ArgumentParser):\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.env = None\n self.args = None\n self.has_stdin_data = False\n self.has_input_data = False\n\n # noinspection PyMethodOverriding\n def parse_args(\n self,\n env: Environment,\n args=None,\n namespace=None\n ) -> argparse.Namespace:\n self.env = env\n self.args, no_options = self.parse_known_args(args, namespace)\n if self.args.debug:\n self.args.traceback = True\n self.has_stdin_data = (\n self.env.stdin\n and not getattr(self.args, 'ignore_stdin', False)\n and not self.env.stdin_isatty\n )\n self.has_input_data = self.has_stdin_data or getattr(self.args, 'raw', None) is not None\n return self.args\n\n # noinspection PyShadowingBuiltins\n def _print_message(self, message, file=None):\n # Sneak in our stderr/stdout.\n if hasattr(self, 'root'):\n env = self.root.env\n else:\n env = self.env\n\n if env is not None:\n file = {\n sys.stdout: env.stdout,\n sys.stderr: env.stderr,\n None: env.stderr\n }.get(file, file)\n\n if not hasattr(file, 'buffer') and isinstance(message, str):\n message = message.encode(env.stdout_encoding)\n super()._print_message(message, file)\n\n\nclass HTTPieManagerArgumentParser(BaseHTTPieArgumentParser):\n def parse_known_args(self, args=None, namespace=None):\n try:\n return super().parse_known_args(args, namespace)\n except SystemExit as exc:\n if not hasattr(self, 'root') and exc.code == 2: # Argument Parser Error\n raise argparse.ArgumentError(None, None)\n raise\n\n\nclass HTTPieArgumentParser(BaseHTTPieArgumentParser):\n \"\"\"Adds additional logic to `argparse.ArgumentParser`.\n\n Handles all input (CLI args, file args, stdin), applies defaults,\n and performs extra validation.\n\n \"\"\"\n\n def __init__(self, *args, formatter_class=HTTPieHelpFormatter, **kwargs):\n kwargs.setdefault('add_help', False)\n super().__init__(*args, formatter_class=formatter_class, **kwargs)\n\n # noinspection PyMethodOverriding\n def parse_args(\n self,\n env: Environment,\n args=None,\n namespace=None\n ) -> argparse.Namespace:\n self.env = env\n self.env.args = namespace = namespace or argparse.Namespace()\n self.args, no_options = super().parse_known_args(args, namespace)\n if self.args.debug:\n self.args.traceback = True\n self.has_stdin_data = (\n self.env.stdin\n and not self.args.ignore_stdin\n and not self.env.stdin_isatty\n )\n self.has_input_data = self.has_stdin_data or self.args.raw is not None\n # Arguments processing and environment setup.\n self._apply_no_options(no_options)\n self._process_request_type()\n self._process_download_options()\n self._setup_standard_streams()\n self._process_output_options()\n self._process_pretty_options()\n self._process_format_options()\n self._guess_method()\n self._parse_items()\n self._process_url()\n self._process_auth()\n self._process_ssl_cert()\n\n if self.args.raw is not None:\n self._body_from_input(self.args.raw)\n elif self.has_stdin_data:\n self._body_from_file(self.env.stdin)\n\n if self.args.compress:\n # TODO: allow --compress with --chunked / --multipart\n if self.args.chunked:\n self.error('cannot combine --compress and --chunked')\n if self.args.multipart:\n self.error('cannot combine --compress and --multipart')\n\n return self.args\n\n def _process_request_type(self):\n request_type = self.args.request_type\n self.args.json = request_type is RequestType.JSON\n self.args.multipart = request_type is RequestType.MULTIPART\n self.args.form = request_type in {\n RequestType.FORM,\n RequestType.MULTIPART,\n }\n\n def _process_url(self):\n if self.args.url.startswith('://'):\n # Paste URL & add space shortcut: `http ://pie.dev` → `http://pie.dev`\n self.args.url = self.args.url[3:]\n if not URL_SCHEME_RE.match(self.args.url):\n if os.path.basename(self.env.program_name) == 'https':\n scheme = 'https://'\n else:\n scheme = self.args.default_scheme + '://'\n\n # See if we're using curl style shorthand for localhost (:3000/foo)\n shorthand = re.match(r'^:(?!:)(\\d*)(/?.*)$', self.args.url)\n if shorthand:\n port = shorthand.group(1)\n rest = shorthand.group(2)\n self.args.url = scheme + 'localhost'\n if port:\n self.args.url += ':' + port\n self.args.url += rest\n else:\n self.args.url = scheme + self.args.url\n\n def _setup_standard_streams(self):\n \"\"\"\n Modify `env.stdout` and `env.stdout_isatty` based on args, if needed.\n\n \"\"\"\n\n self.args.output_file_specified = bool(self.args.output_file)\n if self.args.download:\n # FIXME: Come up with a cleaner solution.\n if not self.args.output_file and not self.env.stdout_isatty:\n # Use stdout as the download output file.\n self.args.output_file = self.env.stdout\n # With `--download`, we write everything that would normally go to\n # `stdout` to `stderr` instead. Let's replace the stream so that\n # we don't have to use many `if`s throughout the codebase.\n # The response body will be treated separately.\n self.env.stdout = self.env.stderr\n self.env.stdout_isatty = self.env.stderr_isatty\n\n elif self.args.output_file:\n # When not `--download`ing, then `--output` simply replaces\n # `stdout`. The file is opened for appending, which isn't what\n # we want in this case.\n self.args.output_file.seek(0)\n try:\n self.args.output_file.truncate()\n except OSError as e:\n if e.errno == errno.EINVAL:\n # E.g. /dev/null on Linux.\n pass\n else:\n raise\n self.env.stdout = self.args.output_file\n self.env.stdout_isatty = False\n\n if self.args.quiet:\n self.env.quiet = self.args.quiet\n self.env.stderr = self.env.devnull\n if not (self.args.output_file_specified and not self.args.download):\n self.env.stdout = self.env.devnull\n self.env.apply_warnings_filter()\n\n def _process_ssl_cert(self):\n from httpie.ssl_ import _is_key_file_encrypted\n\n if self.args.cert_key_pass is None:\n self.args.cert_key_pass = SSLCredentials(None)\n\n if (\n self.args.cert_key is not None\n and self.args.cert_key_pass.value is None\n and _is_key_file_encrypted(self.args.cert_key)\n ):\n self.args.cert_key_pass.prompt_password(self.args.cert_key)\n\n def _process_auth(self):\n # TODO: refactor & simplify this method.\n self.args.auth_plugin = None\n default_auth_plugin = plugin_manager.get_auth_plugins()[0]\n auth_type_set = self.args.auth_type is not None\n url = urlsplit(self.args.url)\n\n if self.args.auth is None and not auth_type_set:\n if url.username is not None:\n # Handle http://username:password@hostname/\n username = url.username\n password = url.password or ''\n self.args.auth = AuthCredentials(\n key=username,\n value=password,\n sep=SEPARATOR_CREDENTIALS,\n orig=SEPARATOR_CREDENTIALS.join([username, password])\n )\n\n if self.args.auth is not None or auth_type_set:\n if not self.args.auth_type:\n self.args.auth_type = default_auth_plugin.auth_type\n plugin = plugin_manager.get_auth_plugin(self.args.auth_type)()\n\n if (not self.args.ignore_netrc\n and self.args.auth is None\n and plugin.netrc_parse):\n # Only host needed, so it’s OK URL not finalized.\n netrc_credentials = get_netrc_auth(self.args.url)\n if netrc_credentials:\n self.args.auth = AuthCredentials(\n key=netrc_credentials[0],\n value=netrc_credentials[1],\n sep=SEPARATOR_CREDENTIALS,\n orig=SEPARATOR_CREDENTIALS.join(netrc_credentials)\n )\n\n if plugin.auth_require and self.args.auth is None:\n self.error('--auth required')\n\n plugin.raw_auth = self.args.auth\n self.args.auth_plugin = plugin\n already_parsed = isinstance(self.args.auth, AuthCredentials)\n\n if self.args.auth is None or not plugin.auth_parse:\n self.args.auth = plugin.get_auth()\n else:\n if already_parsed:\n # from the URL\n credentials = self.args.auth\n else:\n credentials = parse_auth(self.args.auth)\n\n if (not credentials.has_password()\n and plugin.prompt_password):\n if self.args.ignore_stdin:\n # Non-tty stdin read by now\n self.error(\n 'Unable to prompt for passwords because'\n ' --ignore-stdin is set.'\n )\n credentials.prompt_password(url.netloc)\n\n if (credentials.key and credentials.value):\n plugin.raw_auth = credentials.key + \":\" + credentials.value\n\n self.args.auth = plugin.get_auth(\n username=credentials.key,\n password=credentials.value,\n )\n if not self.args.auth and self.args.ignore_netrc:\n # Set a no-op auth to force requests to ignore .netrc\n # \n self.args.auth = ExplicitNullAuth()\n\n def _apply_no_options(self, no_options):\n \"\"\"For every `--no-OPTION` in `no_options`, set `args.OPTION` to\n its default value. This allows for un-setting of options, e.g.,\n specified in config.\n\n \"\"\"\n invalid = []\n\n for option in no_options:\n if not option.startswith('--no-'):\n invalid.append(option)\n continue\n\n # --no-option => --option\n inverted = '--' + option[5:]\n for action in self._actions:\n if inverted in action.option_strings:\n setattr(self.args, action.dest, action.default)\n break\n else:\n invalid.append(option)\n\n if invalid:\n self.error(f'unrecognized arguments: {\" \".join(invalid)}')\n\n def _body_from_file(self, fd):\n \"\"\"Read the data from a file-like object.\n\n Bytes are always read.\n\n \"\"\"\n self._ensure_one_data_source(self.args.data, self.args.files)\n self.args.data = getattr(fd, 'buffer', fd)\n\n def _body_from_input(self, data):\n \"\"\"Read the data from the CLI.\n\n \"\"\"\n self._ensure_one_data_source(self.has_stdin_data, self.args.data,\n self.args.files)\n self.args.data = data.encode()\n\n def _ensure_one_data_source(self, *other_sources):\n \"\"\"There can only be one source of input request data.\n\n \"\"\"\n if any(other_sources):\n self.error('Request body (from stdin, --raw or a file) and request '\n 'data (key=value) cannot be mixed. Pass '\n '--ignore-stdin to let key/value take priority. '\n 'See https://httpie.io/docs#scripting for details.')\n\n def _guess_method(self):\n \"\"\"Set `args.method` if not specified to either POST or GET\n based on whether the request has data or not.\n\n \"\"\"\n if self.args.method is None:\n # Invoked as `http URL'.\n assert not self.args.request_items\n if self.has_input_data:\n self.args.method = HTTP_POST\n else:\n self.args.method = HTTP_GET\n\n # FIXME: False positive, e.g., \"localhost\" matches but is a valid URL.\n elif not re.match('^[a-zA-Z]+$', self.args.method):\n # Invoked as `http URL item+'. The URL is now in `args.method`\n # and the first ITEM is now incorrectly in `args.url`.\n try:\n # Parse the URL as an ITEM and store it as the first ITEM arg.\n self.args.request_items.insert(0, KeyValueArgType(\n *SEPARATOR_GROUP_ALL_ITEMS).__call__(self.args.url))\n\n except argparse.ArgumentTypeError as e:\n if self.args.traceback:\n raise\n self.error(e.args[0])\n\n else:\n # Set the URL correctly\n self.args.url = self.args.method\n # Infer the method\n has_data = (\n self.has_input_data\n or any(\n item.sep in SEPARATOR_GROUP_DATA_ITEMS\n for item in self.args.request_items)\n )\n self.args.method = HTTP_POST if has_data else HTTP_GET\n\n def _parse_items(self):\n \"\"\"\n Parse `args.request_items` into `args.headers`, `args.data`,\n `args.params`, and `args.files`.\n\n \"\"\"\n try:\n request_items = RequestItems.from_args(\n request_item_args=self.args.request_items,\n request_type=self.args.request_type,\n )\n except ParseError as e:\n if self.args.traceback:\n raise\n self.error(e.args[0])\n else:\n self.args.headers = request_items.headers\n self.args.data = request_items.data\n self.args.files = request_items.files\n self.args.params = request_items.params\n self.args.multipart_data = request_items.multipart_data\n\n if self.args.files and not self.args.form:\n # `http url @/path/to/file`\n request_file = None\n for key, file in self.args.files.items():\n if key != '':\n self.error(\n 'Invalid file fields (perhaps you meant --form?):'\n f' {\",\".join(self.args.files.keys())}')\n if request_file is not None:\n self.error(\"Can't read request from multiple files\")\n request_file = file\n\n fn, fd, ct = request_file\n self.args.files = {}\n\n self._body_from_file(fd)\n\n if 'Content-Type' not in self.args.headers:\n content_type = get_content_type(fn)\n if content_type:\n self.args.headers['Content-Type'] = content_type\n\n def _process_output_options(self):\n \"\"\"Apply defaults to output options, or validate the provided ones.\n\n The default output options are stdout-type-sensitive.\n\n \"\"\"\n\n def check_options(value, option):\n unknown = set(value) - OUTPUT_OPTIONS\n if unknown:\n self.error(f'Unknown output options: {option}={\",\".join(unknown)}')\n\n if self.args.verbose:\n self.args.all = True\n\n if self.args.output_options is None:\n if self.args.verbose >= 2:\n self.args.output_options = ''.join(OUTPUT_OPTIONS)\n elif self.args.verbose == 1:\n self.args.output_options = ''.join(BASE_OUTPUT_OPTIONS)\n elif self.args.offline:\n self.args.output_options = OUTPUT_OPTIONS_DEFAULT_OFFLINE\n elif not self.env.stdout_isatty:\n self.args.output_options = OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED\n else:\n self.args.output_options = OUTPUT_OPTIONS_DEFAULT\n\n if self.args.output_options_history is None:\n self.args.output_options_history = self.args.output_options\n\n check_options(self.args.output_options, '--print')\n check_options(self.args.output_options_history, '--history-print')\n\n if self.args.download and OUT_RESP_BODY in self.args.output_options:\n # Response body is always downloaded with --download and it goes\n # through a different routine, so we remove it.\n self.args.output_options = str(\n set(self.args.output_options) - set(OUT_RESP_BODY))\n\n def _process_pretty_options(self):\n if self.args.prettify == PRETTY_STDOUT_TTY_ONLY:\n self.args.prettify = PRETTY_MAP[\n 'all' if self.env.stdout_isatty else 'none']\n elif (self.args.prettify and self.env.is_windows\n and self.args.output_file):\n self.error('Only terminal output can be colorized on Windows.')\n else:\n # noinspection PyTypeChecker\n self.args.prettify = PRETTY_MAP[self.args.prettify]\n\n def _process_download_options(self):\n if self.args.offline:\n self.args.download = False\n self.args.download_resume = False\n return\n if not self.args.download:\n if self.args.download_resume:\n self.error('--continue only works with --download')\n if self.args.download_resume and not (\n self.args.download and self.args.output_file):\n self.error('--continue requires --output to be specified')\n\n def _process_format_options(self):\n format_options = self.args.format_options or []\n parsed_options = PARSED_DEFAULT_FORMAT_OPTIONS\n for options_group in format_options:\n parsed_options = parse_format_options(options_group, defaults=parsed_options)\n self.args.format_options = parsed_options\n\n def print_manual(self):\n from httpie.output.ui import man_pages\n\n if man_pages.is_available(self.env.program_name):\n man_pages.display_for(self.env, self.env.program_name)\n return None\n\n text = self.format_help()\n with self.env.rich_console.pager():\n self.env.rich_console.print(\n text,\n highlight=False\n )\n\n def print_usage(self, file):\n from rich.text import Text\n from httpie.output.ui import rich_help\n\n whitelist = set()\n _, exception, _ = sys.exc_info()\n if (\n isinstance(exception, argparse.ArgumentError)\n and len(exception.args) >= 1\n and isinstance(exception.args[0], argparse.Action)\n and exception.args[0].option_strings\n ):\n # add_usage path is also taken when you pass an invalid option,\n # e.g --style=invalid. If something like that happens, we want\n # to include to action that caused to the invalid usage into\n # the list of actions we are displaying.\n whitelist.add(exception.args[0].option_strings[0])\n\n usage_text = Text('usage', style='bold')\n usage_text.append(':\\n ')\n usage_text.append(rich_help.to_usage(self.spec, whitelist=whitelist))\n self.env.rich_error_console.print(usage_text)\n\n def error(self, message):\n \"\"\"Prints a usage message incorporating the message to stderr and\n exits.\"\"\"\n self.print_usage(sys.stderr)\n self.env.rich_error_console.print(\n dedent(\n f'''\n [bold]error[/bold]:\n {message}\n\n [bold]for more information[/bold]:\n run '{self.prog} --help' or visit https://httpie.io/docs/cli\n '''.rstrip()\n )\n )\n self.exit(2)\n" }, { "path": "httpie/cli/argtypes.py", "content": "import argparse\nimport getpass\nimport os\nimport sys\nfrom copy import deepcopy\nfrom typing import List, Optional, Union\n\nfrom .constants import DEFAULT_FORMAT_OPTIONS, SEPARATOR_CREDENTIALS\nfrom ..sessions import VALID_SESSION_NAME_PATTERN\n\n\nclass KeyValueArg:\n \"\"\"Base key-value pair parsed from CLI.\"\"\"\n\n def __init__(self, key: str, value: Optional[str], sep: str, orig: str):\n self.key = key\n self.value = value\n self.sep = sep\n self.orig = orig\n\n def __eq__(self, other: 'KeyValueArg'):\n return self.__dict__ == other.__dict__\n\n def __repr__(self):\n return repr(self.__dict__)\n\n\nclass SessionNameValidator:\n\n def __init__(self, error_message: str):\n self.error_message = error_message\n\n def __call__(self, value: str) -> str:\n # Session name can be a path or just a name.\n if (os.path.sep not in value\n and not VALID_SESSION_NAME_PATTERN.search(value)):\n raise argparse.ArgumentError(None, self.error_message)\n return value\n\n\nclass Escaped(str):\n \"\"\"Represents an escaped character.\"\"\"\n\n def __repr__(self):\n return f\"Escaped({repr(str(self))})\"\n\n\nclass KeyValueArgType:\n \"\"\"A key-value pair argument type used with `argparse`.\n\n Parses a key-value arg and constructs a `KeyValueArg` instance.\n Used for headers, form data, and other key-value pair types.\n\n \"\"\"\n\n key_value_class = KeyValueArg\n\n def __init__(self, *separators: str):\n self.separators = separators\n self.special_characters = set()\n for separator in separators:\n self.special_characters.update(separator)\n\n def __call__(self, s: str) -> KeyValueArg:\n \"\"\"Parse raw string arg and return `self.key_value_class` instance.\n\n The best of `self.separators` is determined (first found, longest).\n Back slash escaped characters aren't considered as separators\n (or parts thereof). Literal back slash characters have to be escaped\n as well (r'\\\\').\n\n \"\"\"\n tokens = self.tokenize(s)\n\n # Sorting by length ensures that the longest one will be\n # chosen as it will overwrite any shorter ones starting\n # at the same position in the `found` dictionary.\n separators = sorted(self.separators, key=len)\n\n for i, token in enumerate(tokens):\n\n if isinstance(token, Escaped):\n continue\n\n found = {}\n for sep in separators:\n pos = token.find(sep)\n if pos != -1:\n found[pos] = sep\n\n if found:\n # Starting first, longest separator found.\n sep = found[min(found.keys())]\n\n key, value = token.split(sep, 1)\n\n # Any preceding tokens are part of the key.\n key = ''.join(tokens[:i]) + key\n\n # Any following tokens are part of the value.\n value += ''.join(tokens[i + 1:])\n\n break\n\n else:\n raise argparse.ArgumentTypeError(f'{s!r} is not a valid value')\n\n return self.key_value_class(key=key, value=value, sep=sep, orig=s)\n\n def tokenize(self, s: str) -> List[Union[str, Escaped]]:\n r\"\"\"Tokenize the raw arg string\n\n There are only two token types - strings and escaped characters:\n\n >>> KeyValueArgType('=').tokenize(r'foo\\=bar\\\\baz')\n ['foo', Escaped('='), 'bar\\\\\\\\baz']\n\n \"\"\"\n tokens = ['']\n characters = iter(s)\n for char in characters:\n if char == '\\\\':\n char = next(characters, '')\n if char not in self.special_characters:\n tokens[-1] += '\\\\' + char\n else:\n tokens.extend([Escaped(char), ''])\n else:\n tokens[-1] += char\n return tokens\n\n\nclass PromptMixin:\n def _prompt_password(self, prompt: str) -> str:\n prompt_text = f'http: {prompt}: '\n try:\n return self._getpass(prompt_text)\n except (EOFError, KeyboardInterrupt):\n sys.stderr.write('\\n')\n sys.exit(0)\n\n @staticmethod\n def _getpass(prompt):\n # To allow easy mocking.\n return getpass.getpass(str(prompt))\n\n\nclass SSLCredentials(PromptMixin):\n \"\"\"Represents the passphrase for the certificate's key.\"\"\"\n\n def __init__(self, value: Optional[str]) -> None:\n self.value = value\n\n def prompt_password(self, key_file: str) -> None:\n self.value = self._prompt_password(f'passphrase for {key_file}')\n\n\nclass AuthCredentials(KeyValueArg, PromptMixin):\n \"\"\"Represents parsed credentials.\"\"\"\n\n def has_password(self) -> bool:\n return self.value is not None\n\n def prompt_password(self, host: str) -> None:\n self.value = self._prompt_password(f'password for {self.key}@{host}:')\n\n\nclass AuthCredentialsArgType(KeyValueArgType):\n \"\"\"A key-value arg type that parses credentials.\"\"\"\n\n key_value_class = AuthCredentials\n\n def __call__(self, s):\n \"\"\"Parse credentials from `s`.\n\n (\"username\" or \"username:password\").\n\n \"\"\"\n try:\n return super().__call__(s)\n except argparse.ArgumentTypeError:\n # No password provided, will prompt for it later.\n return self.key_value_class(\n key=s,\n value=None,\n sep=SEPARATOR_CREDENTIALS,\n orig=s\n )\n\n\nparse_auth = AuthCredentialsArgType(SEPARATOR_CREDENTIALS)\n\n\ndef readable_file_arg(filename):\n try:\n with open(filename, 'rb'):\n return filename\n except OSError as ex:\n raise argparse.ArgumentTypeError(f'{ex.filename}: {ex.strerror}')\n\n\ndef parse_format_options(s: str, defaults: Optional[dict]) -> dict:\n \"\"\"\n Parse `s` and update `defaults` with the parsed values.\n\n >>> parse_format_options(\n ... defaults={'json': {'indent': 4, 'sort_keys': True}},\n ... s='json.indent:2,json.sort_keys:False',\n ... )\n {'json': {'indent': 2, 'sort_keys': False}}\n\n \"\"\"\n value_map = {\n 'true': True,\n 'false': False,\n }\n options = deepcopy(defaults or {})\n for option in s.split(','):\n try:\n path, value = option.lower().split(':')\n section, key = path.split('.')\n except ValueError:\n raise argparse.ArgumentTypeError(f'invalid option {option!r}')\n\n if value in value_map:\n parsed_value = value_map[value]\n else:\n if value.isnumeric():\n parsed_value = int(value)\n else:\n parsed_value = value\n\n if defaults is None:\n options.setdefault(section, {})\n else:\n try:\n default_value = defaults[section][key]\n except KeyError:\n raise argparse.ArgumentTypeError(\n f'invalid key {path!r}')\n\n default_type, parsed_type = type(default_value), type(parsed_value)\n if parsed_type is not default_type:\n raise argparse.ArgumentTypeError(\n 'invalid value'\n f' {value!r} in {option!r}'\n f' (expected {default_type.__name__}'\n f' got {parsed_type.__name__})'\n )\n\n options[section][key] = parsed_value\n\n return options\n\n\nPARSED_DEFAULT_FORMAT_OPTIONS = parse_format_options(\n s=','.join(DEFAULT_FORMAT_OPTIONS),\n defaults=None,\n)\n\n\ndef response_charset_type(encoding: str) -> str:\n try:\n ''.encode(encoding)\n except LookupError:\n raise argparse.ArgumentTypeError(\n f'{encoding!r} is not a supported encoding')\n return encoding\n\n\ndef response_mime_type(mime_type: str) -> str:\n if mime_type.count('/') != 1:\n raise argparse.ArgumentTypeError(\n f'{mime_type!r} doesn’t look like a mime type; use type/subtype')\n return mime_type\n" }, { "path": "httpie/cli/constants.py", "content": "\"\"\"Parsing and processing of CLI input (args, auth credentials, files, stdin).\n\n\"\"\"\nimport enum\nimport re\n\n\nURL_SCHEME_RE = re.compile(r'^[a-z][a-z0-9.+-]*://', re.IGNORECASE)\n\nHTTP_POST = 'POST'\nHTTP_GET = 'GET'\nHTTP_OPTIONS = 'OPTIONS'\n\n# Various separators used in args\nSEPARATOR_HEADER = ':'\nSEPARATOR_HEADER_EMPTY = ';'\nSEPARATOR_CREDENTIALS = ':'\nSEPARATOR_PROXY = ':'\nSEPARATOR_HEADER_EMBED = ':@'\nSEPARATOR_DATA_STRING = '='\nSEPARATOR_DATA_RAW_JSON = ':='\nSEPARATOR_FILE_UPLOAD = '@'\nSEPARATOR_FILE_UPLOAD_TYPE = ';type=' # in already parsed file upload path only\nSEPARATOR_DATA_EMBED_FILE_CONTENTS = '=@'\nSEPARATOR_DATA_EMBED_RAW_JSON_FILE = ':=@'\nSEPARATOR_QUERY_PARAM = '=='\nSEPARATOR_QUERY_EMBED_FILE = '==@'\n\n# Separators that become request data\nSEPARATOR_GROUP_DATA_ITEMS = frozenset({\n SEPARATOR_DATA_STRING,\n SEPARATOR_DATA_RAW_JSON,\n SEPARATOR_FILE_UPLOAD,\n SEPARATOR_DATA_EMBED_FILE_CONTENTS,\n SEPARATOR_DATA_EMBED_RAW_JSON_FILE\n})\n\nSEPARATORS_GROUP_MULTIPART = frozenset({\n SEPARATOR_DATA_STRING,\n SEPARATOR_DATA_EMBED_FILE_CONTENTS,\n SEPARATOR_FILE_UPLOAD,\n})\n\n# Separators for items whose value is a filename to be embedded\nSEPARATOR_GROUP_DATA_EMBED_ITEMS = frozenset({\n SEPARATOR_HEADER_EMBED,\n SEPARATOR_QUERY_EMBED_FILE,\n SEPARATOR_DATA_EMBED_FILE_CONTENTS,\n SEPARATOR_DATA_EMBED_RAW_JSON_FILE,\n})\n\n# Separators for nested JSON items\nSEPARATOR_GROUP_NESTED_JSON_ITEMS = frozenset([\n SEPARATOR_DATA_STRING,\n SEPARATOR_DATA_RAW_JSON,\n SEPARATOR_DATA_EMBED_FILE_CONTENTS,\n SEPARATOR_DATA_EMBED_RAW_JSON_FILE,\n])\n\n# Separators allowed in ITEM arguments\nSEPARATOR_GROUP_ALL_ITEMS = frozenset({\n SEPARATOR_HEADER,\n SEPARATOR_HEADER_EMPTY,\n SEPARATOR_HEADER_EMBED,\n SEPARATOR_QUERY_PARAM,\n SEPARATOR_QUERY_EMBED_FILE,\n SEPARATOR_DATA_STRING,\n SEPARATOR_DATA_RAW_JSON,\n SEPARATOR_FILE_UPLOAD,\n SEPARATOR_DATA_EMBED_FILE_CONTENTS,\n SEPARATOR_DATA_EMBED_RAW_JSON_FILE,\n})\n\n# Output options\nOUT_REQ_HEAD = 'H'\nOUT_REQ_BODY = 'B'\nOUT_RESP_HEAD = 'h'\nOUT_RESP_BODY = 'b'\nOUT_RESP_META = 'm'\n\nBASE_OUTPUT_OPTIONS = frozenset({\n OUT_REQ_HEAD,\n OUT_REQ_BODY,\n OUT_RESP_HEAD,\n OUT_RESP_BODY,\n})\n\nOUTPUT_OPTIONS = frozenset({\n *BASE_OUTPUT_OPTIONS,\n OUT_RESP_META,\n})\n\n# Pretty\n\n\nclass PrettyOptions(enum.Enum):\n STDOUT_TTY_ONLY = enum.auto()\n\n\nPRETTY_MAP = {\n 'all': ['format', 'colors'],\n 'colors': ['colors'],\n 'format': ['format'],\n 'none': []\n}\nPRETTY_STDOUT_TTY_ONLY = PrettyOptions.STDOUT_TTY_ONLY\n\n\nDEFAULT_FORMAT_OPTIONS = [\n 'headers.sort:true',\n 'json.format:true',\n 'json.indent:4',\n 'json.sort_keys:true',\n 'xml.format:true',\n 'xml.indent:2',\n]\nSORTED_FORMAT_OPTIONS = [\n 'headers.sort:true',\n 'json.sort_keys:true',\n]\nSORTED_FORMAT_OPTIONS_STRING = ','.join(SORTED_FORMAT_OPTIONS)\nUNSORTED_FORMAT_OPTIONS_STRING = ','.join(\n option.replace('true', 'false') for option in SORTED_FORMAT_OPTIONS)\n\n# Defaults\nOUTPUT_OPTIONS_DEFAULT = OUT_RESP_HEAD + OUT_RESP_BODY\nOUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED = OUT_RESP_BODY\nOUTPUT_OPTIONS_DEFAULT_OFFLINE = OUT_REQ_HEAD + OUT_REQ_BODY\n\n\nclass RequestType(enum.Enum):\n FORM = enum.auto()\n MULTIPART = enum.auto()\n JSON = enum.auto()\n" }, { "path": "httpie/cli/definition.py", "content": "from __future__ import annotations\n\nimport os\nimport textwrap\nfrom argparse import FileType\n\nfrom httpie import __doc__, __version__\nfrom httpie.cli.argtypes import (KeyValueArgType, SessionNameValidator,\n SSLCredentials, readable_file_arg,\n response_charset_type, response_mime_type)\nfrom httpie.cli.constants import (BASE_OUTPUT_OPTIONS, DEFAULT_FORMAT_OPTIONS,\n OUT_REQ_BODY, OUT_REQ_HEAD, OUT_RESP_BODY,\n OUT_RESP_HEAD, OUT_RESP_META, OUTPUT_OPTIONS,\n OUTPUT_OPTIONS_DEFAULT, PRETTY_MAP,\n PRETTY_STDOUT_TTY_ONLY,\n SEPARATOR_GROUP_ALL_ITEMS, SEPARATOR_PROXY,\n SORTED_FORMAT_OPTIONS_STRING,\n UNSORTED_FORMAT_OPTIONS_STRING, RequestType)\nfrom httpie.cli.options import ParserSpec, Qualifiers, to_argparse\nfrom httpie.output.formatters.colors import (AUTO_STYLE, DEFAULT_STYLE, BUNDLED_STYLES,\n get_available_styles)\nfrom httpie.plugins.builtin import BuiltinAuthPlugin\nfrom httpie.plugins.registry import plugin_manager\nfrom httpie.ssl_ import AVAILABLE_SSL_VERSION_ARG_MAPPING, DEFAULT_SSL_CIPHERS_STRING\n\n\n# Man pages are static (built when making a release).\n# We use this check to not include generated, system-specific information there (e.g., default --ciphers).\nIS_MAN_PAGE = bool(os.environ.get('HTTPIE_BUILDING_MAN_PAGES'))\n\n\noptions = ParserSpec(\n 'http',\n description=f'{__doc__.strip()} ',\n epilog=\"\"\"\n For every --OPTION there is also a --no-OPTION that reverts OPTION\n to its default value.\n\n Suggestions and bug reports are greatly appreciated:\n https://github.com/httpie/cli/issues\n \"\"\",\n source_file=__file__\n)\n\n#######################################################################\n# Positional arguments.\n#######################################################################\n\npositional_arguments = options.add_group(\n 'Positional arguments',\n description=\"\"\"\n These arguments come after any flags and in the order they are listed here.\n Only URL is required.\n \"\"\",\n)\n\npositional_arguments.add_argument(\n dest='method',\n metavar='METHOD',\n nargs=Qualifiers.OPTIONAL,\n default=None,\n short_help='The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).',\n help=\"\"\"\n The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).\n\n This argument can be omitted in which case HTTPie will use POST if there\n is some data to be sent, otherwise GET:\n\n $ http example.org # => GET\n $ http example.org hello=world # => POST\n\n \"\"\",\n)\npositional_arguments.add_argument(\n dest='url',\n metavar='URL',\n short_help='The request URL.',\n help=\"\"\"\n The request URL. Scheme defaults to 'http://' if the URL\n does not include one. (You can override this with: --default-scheme=http/https)\n\n You can also use a shorthand for localhost\n\n $ http :3000 # => http://localhost:3000\n $ http :/foo # => http://localhost/foo\n\n \"\"\",\n)\npositional_arguments.add_argument(\n dest='request_items',\n metavar='REQUEST_ITEM',\n nargs=Qualifiers.ZERO_OR_MORE,\n default=None,\n type=KeyValueArgType(*SEPARATOR_GROUP_ALL_ITEMS),\n short_help=(\n 'HTTPie’s request items syntax for specifying HTTP headers, JSON/Form'\n 'data, files, and URL parameters.'\n ),\n nested_options=[\n ('HTTP Headers', 'Name:Value', 'Arbitrary HTTP header, e.g X-API-Token:123'),\n ('URL Parameters', 'name==value', 'Querystring parameter to the URL, e.g limit==50'),\n ('Data Fields', 'field=value', 'Data fields to be serialized as JSON (default) or Form Data (with --form)'),\n ('Raw JSON Fields', 'field:=json', 'Data field for real JSON types.'),\n ('File upload Fields', 'field@/dir/file', 'Path field for uploading a file.'),\n ],\n help=r\"\"\"\n Optional key-value pairs to be included in the request. The separator used\n determines the type:\n\n ':' HTTP headers:\n\n Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0\n\n '==' URL parameters to be appended to the request URI:\n\n search==httpie\n\n '=' Data fields to be serialized into a JSON object (with --json, -j)\n or form data (with --form, -f):\n\n name=HTTPie language=Python description='CLI HTTP client'\n\n ':=' Non-string JSON data fields (only with --json, -j):\n\n awesome:=true amount:=42 colors:='[\"red\", \"green\", \"blue\"]'\n\n '@' Form file fields (only with --form or --multipart):\n\n cv@~/Documents/CV.pdf\n cv@'~/Documents/CV.pdf;type=application/pdf'\n\n '=@' A data field like '=', but takes a file path and embeds its content:\n\n essay=@Documents/essay.txt\n\n ':=@' A raw JSON field like ':=', but takes a file path and embeds its content:\n\n package:=@./package.json\n\n You can use a backslash to escape a colliding separator in the field name:\n\n field-name-with\\:colon=value\n\n \"\"\",\n)\n\n#######################################################################\n# Content type.\n#######################################################################\n\ncontent_types = options.add_group('Predefined content types')\n\ncontent_types.add_argument(\n '--json',\n '-j',\n action='store_const',\n const=RequestType.JSON,\n dest='request_type',\n short_help='(default) Serialize data items from the command line as a JSON object.',\n help=\"\"\"\n (default) Data items from the command line are serialized as a JSON object.\n The Content-Type and Accept headers are set to application/json\n (if not specified).\n\n \"\"\",\n)\ncontent_types.add_argument(\n '--form',\n '-f',\n action='store_const',\n const=RequestType.FORM,\n dest='request_type',\n short_help='Serialize data items from the command line as form field data.',\n help=\"\"\"\n Data items from the command line are serialized as form fields.\n\n The Content-Type is set to application/x-www-form-urlencoded (if not\n specified). The presence of any file fields results in a\n multipart/form-data request.\n\n \"\"\",\n)\ncontent_types.add_argument(\n '--multipart',\n action='store_const',\n const=RequestType.MULTIPART,\n dest='request_type',\n short_help=(\n 'Similar to --form, but always sends a multipart/form-data '\n 'request (i.e., even without files).'\n )\n)\ncontent_types.add_argument(\n '--boundary',\n short_help=(\n 'Specify a custom boundary string for multipart/form-data requests. '\n 'Only has effect only together with --form.'\n )\n)\ncontent_types.add_argument(\n '--raw',\n short_help='Pass raw request data without extra processing.',\n help=\"\"\"\n This option allows you to pass raw request data without extra processing\n (as opposed to the structured request items syntax):\n\n $ http --raw='data' pie.dev/post\n\n You can achieve the same by piping the data via stdin:\n\n $ echo data | http pie.dev/post\n\n Or have HTTPie load the raw data from a file:\n\n $ http pie.dev/post @data.txt\n\n\n \"\"\",\n)\n\n#######################################################################\n# Content processing.\n#######################################################################\n\nprocessing_options = options.add_group('Content processing options')\n\nprocessing_options.add_argument(\n '--compress',\n '-x',\n action='count',\n default=0,\n short_help='Compress the content with Deflate algorithm.',\n help=\"\"\"\n Content compressed (encoded) with Deflate algorithm.\n The Content-Encoding header is set to deflate.\n\n Compression is skipped if it appears that compression ratio is\n negative. Compression can be forced by repeating the argument.\n\n \"\"\",\n)\n\n\n#######################################################################\n# Output processing\n#######################################################################\n\n\ndef format_style_help(available_styles, *, isolation_mode: bool = False):\n text = \"\"\"\n Output coloring style (default is \"{default}\"). It can be one of:\n\n {available_styles}\n \"\"\"\n if isolation_mode:\n text += '\\n\\n'\n text += 'For finding out all available styles in your system, try:\\n\\n'\n text += ' $ http --style\\n'\n text += textwrap.dedent(\"\"\"\n The \"{auto_style}\" style follows your terminal's ANSI color styles.\n For non-{auto_style} styles to work properly, please make sure that the\n $TERM environment variable is set to \"xterm-256color\" or similar\n (e.g., via `export TERM=xterm-256color' in your ~/.bashrc).\n \"\"\")\n\n if isolation_mode:\n available_styles = sorted(BUNDLED_STYLES)\n\n available_styles_text = '\\n'.join(\n f' {line.strip()}'\n for line in textwrap.wrap(', '.join(available_styles), 60)\n ).strip()\n return text.format(\n default=DEFAULT_STYLE,\n available_styles=available_styles_text,\n auto_style=AUTO_STYLE,\n )\n\n\n_sorted_kwargs = {\n 'action': 'append_const',\n 'const': SORTED_FORMAT_OPTIONS_STRING,\n 'dest': 'format_options',\n}\n_unsorted_kwargs = {\n 'action': 'append_const',\n 'const': UNSORTED_FORMAT_OPTIONS_STRING,\n 'dest': 'format_options',\n}\n\noutput_processing = options.add_group('Output processing')\n\noutput_processing.add_argument(\n '--pretty',\n dest='prettify',\n default=PRETTY_STDOUT_TTY_ONLY,\n choices=sorted(PRETTY_MAP.keys()),\n short_help='Control the processing of console outputs.',\n help=\"\"\"\n Controls output processing. The value can be \"none\" to not prettify\n the output (default for redirected output), \"all\" to apply both colors\n and formatting (default for terminal output), \"colors\", or \"format\".\n\n \"\"\",\n)\noutput_processing.add_argument(\n '--style',\n '-s',\n dest='style',\n metavar='STYLE',\n default=DEFAULT_STYLE,\n action='lazy_choices',\n getter=get_available_styles,\n short_help=f'Output coloring style (default is \"{DEFAULT_STYLE}\").',\n help_formatter=format_style_help,\n)\n\n# The closest approx. of the documented resetting to default via --no-