معرفی شرکت ها
conviso-flowcli-1.9.5rc1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
-
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | conviso-flowcli-1.9.5rc1 |
| نام | conviso-flowcli |
| نسخه کتابخانه | 1.9.5rc1 |
| نگهدارنده | ['Jean Carlos Sales Pantoja'] |
| ایمیل نگهدارنده | ['jpantoja@convisoappsec.com'] |
| نویسنده | - |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/conviso-flowcli/ |
| مجوز | - |
# Flowcli
This is a command line tool to interact with [convisoappsec] flow api. This aims to be very useful for integrations development.
# Installation
To install flowcli some dependecies are required:
* python3 >= 3.4. See [python3 download]
* pip. See [pip guide]
* git. See [git download]
* Docker. See [docker download]
If you have system admin privileges just execute one of the following commands.
```sh
pip install conviso-flowcli
```
or
```sh
python3 -m pip install conviso-flowcli
```
If you haven't system admin privileges execute one of the following commands.
```sh
pip install --user conviso-flowcli
```
or
```sh
python3 -m pip install --user conviso-flowcli
```
Check if the install command was well succeeded.
```sh
flow --version
```
The command will print the current version and exit with success. Now we are ready to proceed.
# Getting started
## Overview
The primary goal of the flowcli aims to be a developer friendly tool. The tool will automate as many steps as possible to decrease spent time on an integration with [appsec flow]. Using this tool the integration with your [CI/CD] platform will be easy. At your [CI/CD] you be able to perform [SAST] and [DAST] analysis, send source code to be reviewed by our analysts and order features availables in your [appsec flow account].
# Shell Completion
This section will guide you to activate the flow shell completion. This is not required to use the tool so you can skip it if you want.
## Bash
Open your .bashrc file at ~/.bashrc and place the following snippet in the end of file.
```sh
FLOW_COMPLETER="$(which flow_bash_completer.sh)"
[ -f "$FLOW_COMPLETER" ] && {
source "$FLOW_COMPLETER"
}
```
Start a new bash shell session and the shell completion will be available.
## Zsh
Open your .zshrc file at ~/.zshrc and place the following snippet in the end of file.
```sh
FLOW_COMPLETER="$(which flow_zsh_completer.sh)"
[ -f "$FLOW_COMPLETER" ] && {
source "$FLOW_COMPLETER"
}
```
Start a new zsh shell session and the shell completion will be available.
## Fish
Start a fish shell session and execute the following command.
```sh
mkdir -p ~/.config/fish/completions
cp (which flow_fish_completer.fish) ~/.config/fish/completions/flow.fish
```
Start a new fish shell session and the shell completion will be available.
## Main command
The main command of flowcli is flow. To see the command help run the following command.
```sh
flow -h
```
or
```sh
flow --help
```
## Authentication
To start with flowcli an [appsec flow] api key(See [generating api key]) will be necessary. After you got it you can export the key as system environment variable
and use the flowcli.
```sh
export FLOW_API_KEY='you-api-key'
```
or the api key can be set as option argument
```sh
flow --api-key 'you-api-key' [SOME COMMAND]
```
## Static program analysis(SAST)
With the flowcli is very simple to perform a SAST at your source code repository. Let's see some examples.
### Reporting the SAST results to [Flow AppSec] API
To report the SAST result to flow api a project code will be required. The project is created at [Flow AppSec] Web View. See [creating project].
Assuming that my_source_code_repository is a git repository, so:
```sh
export FLOW_API_KEY='your-api-key'
export FLOW_PROJECT_CODE='your-project-code'
cd my_source_code_repository
flow sast run
```
The following instructions has the same effect.
```sh
cd my_source_code_repository
flow --api-key 'your-api-key' sast run --project-code 'your-project-code'
```
[python3 download]: <https://www.python.org/downloads/>
[git download]: <https://git-scm.com/downloads>
[pip guide]: <https://packaging.python.org/tutorials/installing-packages/#installing-from-pypi>
[docker download]: <https://docs.docker.com/engine/install/>
[bash]: <https://www.gnu.org/software/bash/>
[zsh]: <https://www.zsh.org/>
[fish]: <https://fishshell.com/>
[convisoappsec]: <https://convisoappsec.com/>
[generating api key]: <https://appsecflow.helpy.io/>
[generating project code]: <https://appsecflow.helpy.io/>
[appsec flow]: <https://appsecflow.helpy.io/>
[CI/CD]: <https://en.wikipedia.org/wiki/CI/CD>
[SAST]: <https://blog.convisoappsec.com/en/code-review-and-sast-whats-the-difference/>
[DAST]: <https://blog.convisoappsec.com/en/code-review-and-sast-whats-the-difference/>
[creating project]: <https://appsecflow.helpy.io/>
[appsec flow account]: <https://appsecflow.helpy.io/>
[Flow AppSec]: <https://app.conviso.com.br/>
نیازمندی
| مقدار | نام |
|---|---|
| <4,>=3.1.2 | GitPython |
| <8,>=7.1.2 | click |
| <3,>=2.23.0 | requests |
| <3,>=2.8.5 | semantic-version |
| <5,>=4.2.1 | docker |
| <6,>=5.3.1 | PyYAML |
| <1,>=0.3.2 | click-log |
| <1,>=0.8.7 | transitions |
| <3,>=2.5.1 | jsonschema |
| ==1.2.2 | git-url-parse |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.5 | Python |
نحوه نصب
نصب پکیج whl conviso-flowcli-1.9.5rc1:
pip install conviso-flowcli-1.9.5rc1.whl
نصب پکیج tar.gz conviso-flowcli-1.9.5rc1:
pip install conviso-flowcli-1.9.5rc1.tar.gz