Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 50 additions & 17 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ English|[中文](../README.md)

- [Introduction](#introduction)
- [Detection Ability](#detection-ability)
- [Download \& Deployment](#download--deployment)
- [Installation](#installation)
- [Method 1: Download from Releases](#method-1-download-from-releases)
- [Method 2: Use install script](#method-2-use-install-script)
- [Method 3: Use package manager(Homebrew)](#method-3-use-package-managerhomebrew)
- [Method 4: Build from source](#method-4-build-from-source)
- [Use OpenSCA](#use-opensca)
- [Parameters](#parameters)
- [Report Formats](#report-formats)
Expand Down Expand Up @@ -64,28 +68,57 @@ OpenSCA is now capable of parsing configuration files in the listed programming
| `Erlang` | `Rebar` | `rebar.lock` |
| `Python` | `Pip` | `Pipfile` `Pipfile.lock` `setup.py` `requirements.txt` `requirements.in`(For the latter two, pipenv environment & internet connection are needed) |

## Download & Deployment
## Installation

OpenSCA-cli is available for Windows, Linux and MacOS. The installation method is as follows:

### Method 1: Download from Releases

1. Download the appropriate executable file according to your system architecture from [releases](https://github.com/XmirrorSecurity/OpenSCA-cli/releases).
2. Unzip the downloaded file and run `opensca-cli` directly.

### Method 2: Use install script

- For Mac/Linux Users
```shell
curl -sSL https://raw.githubusercontent.com/XmirrorSecurity/OpenSCA-cli/master/scripts/install.sh | sh

# Try this when internet connection fails
curl -sSL https://gitee.com/XmirrorSecurity/OpenSCA-cli/raw/master/scripts/install.sh | sh -s -- gitee
```
- For Windows Users(need PowerShell)
```powershell
iex "&{$(irm https://raw.githubusercontent.com/XmirrorSecurity/OpenSCA-cli/master/scripts/install.ps1)}"

# Try this when internet connection fails
iex "&{$(irm https://gitee.com/XmirrorSecurity/OpenSCA-cli/raw/master/scripts/install.ps1)} gitee"
```

2. Or download the source code and compile (`go 1.18` and above is needed)
### Method 3: Use package manager(Homebrew)
```shell
brew install opensca-cli
```

### Method 4: Build from source

```shell
// github linux/mac
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
// gitee linux/mac
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
// github windows
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
// gitee windows
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
```
Clone the source code and compile (`go 1.18` and above is needed)

```shell
# github linux/mac
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
# gitee linux/mac
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
# github windows
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
# gitee windows
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
```

The default option is to generate the program of the current system architecture. If you want to try it for other system architectures, you can set the following environment variables before compiling.
The default option is to generate the program of the current system architecture. If you want to try it for other system architectures, you can set the following environment variables before compiling.

- Disable `CGO_ENABLED` `CGO_ENABLED=0`
- Set the operating system `GOOS=${OS} \\ darwin,liunx,windows`
- Set the architecture `GOARCH=${arch} \\ amd64,arm64`
- Disable `CGO_ENABLED` `CGO_ENABLED=0`
- Set the operating system `GOOS=${OS} \\ darwin,liunx,windows`
- Set the architecture `GOARCH=${arch} \\ amd64,arm64`

## Use OpenSCA

Expand Down
84 changes: 59 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
- [项目介绍](#项目介绍)
- [检测能力](#检测能力)
- [下载安装](#下载安装)
- [方式 1: 从 Releases 下载](#方式-1-从-releases-下载)
- [方式 2: 一键安装脚本](#方式-2-一键安装脚本)
- [方式 3: 使用包管理器(Homebrew)](#方式-3-使用包管理器homebrew)
- [方式 4: 从源码构建](#方式-4-从源码构建)
- [使用说明](#使用说明)
- [参数说明](#参数说明)
- [报告格式](#报告格式)
Expand Down Expand Up @@ -61,33 +65,63 @@

## 下载安装

OpenSCA-cli 支持 Windows、Linux、MacOS 等操作系统,支持 x86_64 和 arm64 架构。目前提供了以下几种安装方式:

### 方式 1: 从 Releases 下载

1. 从 [github](https://github.com/XmirrorSecurity/OpenSCA-cli/releases) 或 [gitee](https://gitee.com/XmirrorSecurity/OpenSCA-cli/releases) 或 [gitcode](https://gitcode.com/XmirrorSecurity/OpenSCA-cli/releases) 下载对应系统架构的可执行文件压缩包
2. 解压,并运行 `opensca-cli` 可执行文件即可。

### 方式 2: 一键安装脚本

- Mac/Linux 用户
```shell
curl -sSL https://raw.githubusercontent.com/XmirrorSecurity/OpenSCA-cli/master/scripts/install.sh | sh

# 如果遇到网络问题,可尝试以下命令
curl -sSL https://gitee.com/XmirrorSecurity/OpenSCA-cli/raw/master/scripts/install.sh | sh -s -- gitee
```
- For Windows Users(need PowerShell)
```powershell
iex "&{$(irm https://raw.githubusercontent.com/XmirrorSecurity/OpenSCA-cli/master/scripts/install.ps1)}"

# 如遇到网络问题,可尝试以下命令
iex "&{$(irm https://gitee.com/XmirrorSecurity/OpenSCA-cli/raw/master/scripts/install.ps1)} gitee"
```

### 方式 3: 使用包管理器(Homebrew)

```
brew install opensca-cli
```

### 方式 4: 从源码构建

克隆并源码编译(需要 `go 1.18` 及以上版本)

```shell
# github linux/mac
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
# gitee linux/mac
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
# gitcode linux/mac
git clone https://gitcode.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
# github windows
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
# gitee windows
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
# gitcode windows
git clone https://gitcode.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
```

默认生成当前系统架构的程序,如需生成其他系统架构可配置环境变量后编译

2. 或者下载源码编译(需要 `go 1.18` 及以上版本)

```shell
// github linux/mac
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
// gitee linux/mac
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
// gitcode linux/mac
git clone https://gitcode.com/XmirrorSecurity/OpenSCA-cli.git opensca && cd opensca && go build
// github windows
git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
// gitee windows
git clone https://gitee.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
// gitcode windows
git clone https://gitcode.com/XmirrorSecurity/OpenSCA-cli.git opensca ; cd opensca ; go build
```

默认生成当前系统架构的程序,如需生成其他系统架构可配置环境变量后编译

- 禁用`CGO_ENABLED`
`CGO_ENABLED=0`
- 指定操作系统
`GOOS=${OS} \\ darwin,liunx,windows`
- 指定体系架构
`GOARCH=${arch} \\ amd64,arm64`
- 禁用`CGO_ENABLED`
`CGO_ENABLED=0`
- 指定操作系统
`GOOS=${OS} \\ darwin,liunx,windows`
- 指定体系架构
`GOARCH=${arch} \\ amd64,arm64`

## 使用说明

Expand Down
Loading