Clarify support for ecosystems and pip status

Updated README to clarify that Aikido Safe Chain currently supports only JavaScript ecosystems and marks pip and pip3 as beta.
This commit is contained in:
bitterpanda 2025-11-12 16:15:32 +01:00 committed by Sander Declerck
parent 06b287d4d4
commit 86fb69a931
No known key found for this signature in database

View file

@ -1,6 +1,6 @@
# Aikido Safe Chain # Aikido Safe Chain
The Aikido Safe Chain **prevents developers from installing malware** on their workstations while developing in the Python ecosystem (through pip or pip3, including `python -m pip[...]` and `python3 -m pip[...]` where available) or in the Javascript ecosystem (through npm, npx, yarn, pnpm, pnpx, bun and bunx). It's **free** to use and does not require any token. The Aikido Safe Chain **prevents developers from installing malware** on their workstations while developing in the Javascript ecosystem (through npm, npx, yarn, pnpm, pnpx, bun and bunx). It's **free** to use and does not require any token.
The Aikido Safe Chain wraps around the [npm cli](https://github.com/npm/cli), [npx](https://github.com/npm/cli/blob/latest/docs/content/commands/npx.md), [yarn](https://yarnpkg.com/), [pnpm](https://pnpm.io/), [pnpx](https://pnpm.io/cli/dlx), [bun](https://bun.sh/), [bunx](https://bun.sh/docs/cli/bunx), and [pip](https://pip.pypa.io/) to provide extra checks before installing new packages. This tool will detect when a package contains malware and prompt you to exit, preventing npm, npx, yarn, pnpm, pnpx, bun, bunx, or pip/pip3 from downloading or running the malware. The Aikido Safe Chain wraps around the [npm cli](https://github.com/npm/cli), [npx](https://github.com/npm/cli/blob/latest/docs/content/commands/npx.md), [yarn](https://yarnpkg.com/), [pnpm](https://pnpm.io/), [pnpx](https://pnpm.io/cli/dlx), [bun](https://bun.sh/), [bunx](https://bun.sh/docs/cli/bunx), and [pip](https://pip.pypa.io/) to provide extra checks before installing new packages. This tool will detect when a package contains malware and prompt you to exit, preventing npm, npx, yarn, pnpm, pnpx, bun, bunx, or pip/pip3 from downloading or running the malware.
@ -15,8 +15,8 @@ Aikido Safe Chain works on Node.js version 18 and above and supports the followi
- ✅ **pnpx** - ✅ **pnpx**
- ✅ **bun** - ✅ **bun**
- ✅ **bunx** - ✅ **bunx**
- ✅ **pip** - ✅ **pip** (beta)
- ✅ **pip3** - ✅ **pip3** (beta)
# Usage # Usage
@ -41,7 +41,7 @@ Installing the Aikido Safe Chain is easy. You just need 3 simple steps:
npm install safe-chain-test npm install safe-chain-test
``` ```
For Python: For Python (beta):
```shell ```shell
pip3 install safe-chain-pi-test pip3 install safe-chain-pi-test
``` ```