mirror of
https://github.com/AikidoSec/safe-chain.git
synced 2026-05-26 12:10:49 +00:00
Some more doc updates
This commit is contained in:
parent
53e47581d4
commit
a99762fc28
3 changed files with 2 additions and 24 deletions
16
README.md
16
README.md
|
|
@ -34,16 +34,12 @@ Installing the Aikido Safe Chain is easy with our one-line installer.
|
||||||
|
|
||||||
### Unix/Linux/macOS
|
### Unix/Linux/macOS
|
||||||
|
|
||||||
**Default installation (JavaScript packages only):**
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh
|
curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh
|
||||||
```
|
```
|
||||||
|
|
||||||
### Windows (PowerShell)
|
### Windows (PowerShell)
|
||||||
|
|
||||||
**Default installation:**
|
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
iex (iwr "https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1" -UseBasicParsing)
|
iex (iwr "https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1" -UseBasicParsing)
|
||||||
```
|
```
|
||||||
|
|
@ -62,7 +58,7 @@ iex (iwr "https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-sc
|
||||||
npm install safe-chain-test
|
npm install safe-chain-test
|
||||||
```
|
```
|
||||||
|
|
||||||
For Python (if you enabled Python support):
|
For Python:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
pip3 install safe-chain-pi-test
|
pip3 install safe-chain-pi-test
|
||||||
|
|
@ -181,26 +177,16 @@ Use the `--ci` flag to automatically configure Aikido Safe Chain for CI/CD envir
|
||||||
|
|
||||||
### Unix/Linux/macOS (GitHub Actions, Azure Pipelines, etc.)
|
### Unix/Linux/macOS (GitHub Actions, Azure Pipelines, etc.)
|
||||||
|
|
||||||
**JavaScript only:**
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci
|
curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci
|
||||||
```
|
```
|
||||||
|
|
||||||
### Windows (Azure Pipelines, etc.)
|
### Windows (Azure Pipelines, etc.)
|
||||||
|
|
||||||
**JavaScript only:**
|
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci"
|
iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci"
|
||||||
```
|
```
|
||||||
|
|
||||||
**With Python support:**
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci -includepython"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Supported Platforms
|
## Supported Platforms
|
||||||
|
|
||||||
- ✅ **GitHub Actions**
|
- ✅ **GitHub Actions**
|
||||||
|
|
|
||||||
|
|
@ -3,8 +3,7 @@
|
||||||
# Usage with "iex (iwr {url} -UseBasicParsing)" --> See README.md
|
# Usage with "iex (iwr {url} -UseBasicParsing)" --> See README.md
|
||||||
|
|
||||||
param(
|
param(
|
||||||
[switch]$ci,
|
[switch]$ci
|
||||||
[switch]$includepython
|
|
||||||
)
|
)
|
||||||
|
|
||||||
$Version = $env:SAFE_CHAIN_VERSION # Will be fetched from latest release if not set
|
$Version = $env:SAFE_CHAIN_VERSION # Will be fetched from latest release if not set
|
||||||
|
|
@ -117,9 +116,6 @@ function Install-SafeChain {
|
||||||
|
|
||||||
# Build installation message
|
# Build installation message
|
||||||
$installMsg = "Installing safe-chain $Version"
|
$installMsg = "Installing safe-chain $Version"
|
||||||
if ($includepython) {
|
|
||||||
$installMsg += " with python"
|
|
||||||
}
|
|
||||||
if ($ci) {
|
if ($ci) {
|
||||||
$installMsg += " in ci"
|
$installMsg += " in ci"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -145,7 +145,6 @@ parse_arguments() {
|
||||||
main() {
|
main() {
|
||||||
# Initialize argument flags
|
# Initialize argument flags
|
||||||
USE_CI_SETUP=false
|
USE_CI_SETUP=false
|
||||||
INCLUDE_PYTHON=false
|
|
||||||
|
|
||||||
# Parse command-line arguments
|
# Parse command-line arguments
|
||||||
parse_arguments "$@"
|
parse_arguments "$@"
|
||||||
|
|
@ -158,9 +157,6 @@ main() {
|
||||||
|
|
||||||
# Build installation message
|
# Build installation message
|
||||||
INSTALL_MSG="Installing safe-chain ${VERSION}"
|
INSTALL_MSG="Installing safe-chain ${VERSION}"
|
||||||
if [ "$INCLUDE_PYTHON" = "true" ]; then
|
|
||||||
INSTALL_MSG="${INSTALL_MSG} with python"
|
|
||||||
fi
|
|
||||||
if [ "$USE_CI_SETUP" = "true" ]; then
|
if [ "$USE_CI_SETUP" = "true" ]; then
|
||||||
INSTALL_MSG="${INSTALL_MSG} in ci"
|
INSTALL_MSG="${INSTALL_MSG} in ci"
|
||||||
fi
|
fi
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue