Skip to content

Commit aa328a9

Browse files
committed
add readme and license to cli package for publishing
1 parent d27ecb7 commit aa328a9

5 files changed

Lines changed: 87 additions & 2 deletions

File tree

packages/flowtest-cli/LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Sajal Jain
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

packages/flowtest-cli/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# flowtestai-cli
2+
3+
With FlowTestAI CLI, you can now run your end to end tests directly from command line.
4+
5+
This makes it easier to run your tests in different environments, automate your testing process, and integrate your tests with your continuous integration and deployment workflows.
6+
7+
## Installation
8+
9+
To install the FlowTestAI CLI, use the node package manager of your choice, such as NPM:
10+
11+
```bash
12+
npm install -g @flowtestai/cli
13+
```
14+
15+
## Getting started
16+
17+
Navigate to the root directory of your collection, and then run:
18+
19+
```bash
20+
flow run help
21+
```
22+
23+
This command will give you various options you can use to run a flow. You can also run a single flow by specifying its filename with the `--file` or `-f` option:
24+
25+
```bash
26+
flow run -f test.flow
27+
```
28+
29+
Or run a requests inside a subfolder:
30+
31+
```bash
32+
flow run -f folder/subfolder/test.flow
33+
```
34+
35+
If you need to use an environment, you can specify it with the `--env` or `-e` option:
36+
37+
```bash
38+
flow run -f test.flow -e environments/test.env
39+
```
40+
41+
If you need to publish the results of your flow runs for further analysis, you can specify the `-s` option. Request your access key pairs from https://flowtest-ai.vercel.app/ and then export $FLOWTEST_ACCESS_ID and $FLOWTEST_ACCESS_KEY
42+
43+
```bash
44+
flow run -f test.flow -e environments/test.env -s
45+
```
46+
47+
## Demo
48+
49+
![demo1](assets/demo1.png)
50+
![demo2](assets/demo2.png)
51+
52+
## Support
53+
54+
If you encounter any issues or have any feedback or suggestions, please raise them on our [GitHub repository](https://github.com/FlowTestAI/FlowTest)
55+
56+
Thank you for using Bruno CLI!
57+
58+
## Changelog
59+
60+
See [https://github.com/FlowTestAI/FlowTest/releases](https://github.com/FlowTestAI/FlowTest/releases)
61+
62+
## License
63+
64+
[MIT](LICENSE.md)
1.56 MB
Loading
1.13 MB
Loading

packages/flowtest-cli/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
"name": "flowtest-cli",
2+
"name": "@flowtestai/cli",
33
"version": "1.0.0",
44
"description": "CLI to run flow from command line",
55
"main": "bin/index.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
88
},
99
"bin": {
10-
"flow": "./bin/index.js"
10+
"flow": "bin/index.js"
1111
},
1212
"author": "Sajal Jain <jsajal1993@gmail.com>",
1313
"license": "MIT",

0 commit comments

Comments
 (0)