# Flow Step Toolkit SDK

The Flow Step Tool SDK provides the following capabilities:

- Basic abilities:
- The paths, environment variables, and secret settings for job execution
- Provide log printing capabilities at different levels, such as DEBUG, INFO, Warning, ERROR, etc
- Tool installation: Provides the ability to download and cache tools
- Process Call: Provides the ability to call command-line tools and retrieve call logs
- Flow Integration: Provides the ability to interact with the Flow system, such as obtaining Maven Settings configuration, ACR image repository account security information, etc

# Quickstart
Initialization project
``` shell
// Install the flow-ci project initialization tool
npm install -g @flow-step/flow-cli --registry=https://registry.npmmirror.com

// Project initialization (requires node version>=16)
flow-cli step init
'? Step Sign: HelloV2Step'
...
```
Download dependencies and testing
```shell
cd HelloV2Step
npm install --registry=https://registry.npmmirror.com
npm run test
```
![cnpm run test](./pictures/run_test.png)

Build and Run
```shell
npm run build
node dist/index.js 
```
![node dist/index.js](./pictures/node_dist_index.png)

# Reference
* [examples](./examples/README.md)