milliways-infosec/AikidoSec-safe-chain
7
0
Fork 0
mirror of https://github.com/AikidoSec/safe-chain.git synced 2026-05-26 12:10:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #126 from AikidoSec/remove-malware-action-docs

Browse source 
Remove --safe-chain-malware-action documentation
This commit is contained in:
bitterpanda 2025-10-27 14:03:26 +01:00 • committed by GitHub
commit c284ad7ba9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -41,6 +41,7 @@ Installing the Aikido Safe Chain is easy. You just need 3 simple steps:
When running `npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, or `bunx` commands, the Aikido Safe Chain will automatically check for malware in the packages you are trying to install. If any malware is detected, it will prompt you to exit the command.
You can check the installed version by running:
```shell
safe-chain --version
```
@ -75,19 +76,6 @@ To uninstall the Aikido Safe Chain, you can run the following command:
# Configuration
## Malware Action
You can control how Aikido Safe Chain responds when malware is detected using the `--safe-chain-malware-action` flag:
- `--safe-chain-malware-action=block` (**default**) - Automatically blocks installation and exits with an error when malware is detected
- `--safe-chain-malware-action=prompt` - Prompts the user to decide whether to continue despite the malware detection
Example usage:
```shell
npm install suspicious-package --safe-chain-malware-action=prompt
```
## Logging
You can control the output from Aikido Safe Chain using the `--safe-chain-logging` flag: