Skip to main content

patched cli

Project description


patched-cli is a CLI that generates vulnerability patches for your codebase.

Quickstart guide

  1. Install patched-cli.
    pip install patched-cli
  2. Run patched-cli with your git repository as its argument or working directory. When the working directory is the git repository
    When the argument is the git repository
    patched-cli /path/to/my/git/repository
  3. If this is the first time running patched-cli, you will be redirected to patched's sign-in page to generate a token. Copy the token and paste it to the prompt. If this is not the first time running patched-cli an application directory should already exist under your user's home directory if you are using a Unix-based operating system or AppData folder if you are using a windows based operating system. Alternatively you can set the environment variable PATCHED_ACCESS_TOKEN before running patched-cli.
    export PATCHED_ACCESS_TOKEN="your-patched-access-token-here"
  4. To create a pull request you can set the --create-pr flag.
    patched-cli --create-pr
    If is not installed in your GitHub repository you can give patched-cli your GitHub Personal Access Token via the option --github-access-token or set the environment variable PATCHED_GITHUB_TOKEN
    patched-cli --create-pr

Extras for Windows users

patched-cli only supports Windows using WSL(Windows Subsystem for Linux). Please consult WSL install for more information.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

patched_cli-1.1.4.tar.gz (2.4 MB view hashes)

Uploaded Source

Built Distribution

patched_cli-1.1.4-py3-none-any.whl (2.5 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page