From 71ee1a0d5294ae3d5b43119d9ccfcb32ca446c27 Mon Sep 17 00:00:00 2001 From: Carl Walsh Date: Fri, 27 Oct 2023 13:54:50 -0700 Subject: [PATCH] Document cleanCache in README The cleanCache command should be documented in README, see https://github.com/serverless/serverless-python-requirements/issues/437#issuecomment-1155659925 This doesn't fix issue #437 -- but it makes the workaround more visible. Move commands from inline code markdown to code blocks to make them more visible. --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6032725a..e75bbba7 100644 --- a/README.md +++ b/README.md @@ -450,12 +450,27 @@ functions: vendor: ./hello-vendor # The option is also available at the function level ``` -## Manual invocations +## Manual invocation -The `.requirements` and `requirements.zip`(if using zip support) files are left -behind to speed things up on subsequent deploys. To clean them up, run -`sls requirements clean`. You can also create them (and `unzip_requirements` if -using zip support) manually with `sls requirements install`. +The `.requirements` and `requirements.zip` (if using zip support) files are left +behind to speed things up on subsequent deploys. To clean them up, run: + +```plaintext +sls requirements clean +``` + +You can also create them (and `unzip_requirements` if +using zip support) manually with: + +```plaintext +sls requirements install +``` + +The pip download/static cache is outside the serverless folder, and should be manually cleaned when i.e. changing python versions: + +```plaintext +sls requirements cleanCache +``` ## Invalidate requirements caches on package