External/securelens-backend
1
0
Fork 0
mirror of https://github.com/Rarebuffalo/securelens-backend.git synced 2026-06-19 07:00:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

update setup onboarding with cross-platform git install commands

Browse Source
This commit is contained in:
rarebuffalo
2026-06-15 00:52:32 +05:30
parent 2d074d1d37
commit 20bd779417
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
SETUP.md
View File

@@ -88,25 +88,26 @@ This starts the containers in the background, maps port 8000 to the host, and pe
The `securelens` CLI allows you to execute scans directly from your local terminal and synchronize reports back to your backend account. The `securelens` CLI allows you to execute scans directly from your local terminal and synchronize reports back to your backend account.
### 1. Automated Script Installation Choose one of the following installation methods based on your platform and preferences:
You can install the CLI automatically using the provided installer: ### Method A: One-Line Global Installation (Cross-Platform)
Recommended for general use. Installs the CLI globally on Windows, macOS, or Linux directly from the remote repository without needing to clone it:
```bash
pip install git+https://github.com/Rarebuffalo/securelens-backend.git#subdirectory=cli
```
*(Or use `pipx install git+...` to automatically isolate the tool in its own environment).*
### Method B: Local Source Installation (Development)
If you are contributing to this codebase or want to install it from the cloned repository folder:
#### 1. Automated Script Installation (Linux/macOS)
```bash ```bash
chmod +x cli/install.sh chmod +x cli/install.sh
./cli/install.sh ./cli/install.sh
```
Ensure you have activated your virtual environment before running the tool:
```bash
source venv/bin/activate source venv/bin/activate
``` ```
### 2. Manual Installation #### 2. Manual Installation (Windows / Cross-Platform)
Alternatively, you can install the CLI in editable mode manually:
```bash ```bash
pip install -e cli/ pip install -e cli/
``` ```