@siliceum/calcite-cli
v0.8.1
Published
The Calcite CI agent to extract, transform and load your data, from files to server
Downloads
4
Readme
README.md
calcite-ci-agent
About
The Calcite CI agent to extract, transform and load your data, from files to server.
This package is maintained by siliceum company.
Usage
Install the cli on your environment (global install)
npm install -g @siliceum/calcite-cli
Upload
Calcite works by aggregating data from your performance test suites. You can upload and import data using the calcite upload
command and writing your own calcite.config.js
file.
More details in the online documentation dedicated to dataset uploads.
calcite upload [options] <filePath>
Options:
-u, --url <server url> Set the target server url, for preview and enterprise users. Protocol must be included (http or https). The `CALCITE_URL` environment variable can also be used, otherwise it will be set to the public server.
-t, --token <token id> Set the project token. By default the `CALCITE_TOKEN` environment variable is used.
-C, --commit <sha> Specify the full git commit sha.
-D, --date <ISO8601 date> Specify the git commit date. In the ISO8601 format.
-M, --message <body> Specify the commit message (body).
-R, --ref <gitref> Specify the git ref.
-BC, --benchconfig <sha> Specify the benchmark config name.
-BID, --buildId <id> Specify the CI build number.
-PR, --pullRequestId <id> Specify the pull request number.
--dry-run Do not upload, instead print the content of the payload to the console.
-h, --help display help for command
Trigger a calcite workflow
Once data has been uploaded, you can trigger a calcite workflow using the calcite trigger
command.
More details in the online documentation dedicated to workflow triggers
Usage: calcite trigger [options] <baseline_id> [target_id]
Options:
-u, --url <server url> Set the target server url, for preview and enterprise users. The `CALCITE_URL` environment variable can also be used, otherwise it will be set to the public server.
-t, --token <token id> Set the project token. By default the `CALCITE_TOKEN` environment variable is used.
-tt, --triggertags <taglist> Comma seperated list of tags for this workflow. This is used as a filter for alerts.
-PR, --pullRequestId <id> Specify the pull request number.
-h, --help display help for command
Contributing
What do we use to build the application?
- Typescript
- Static analysis through ESLint
- Unit testing and coverage through Jest
Prepare your environment
- Install node.js
- run
npm install
in the root folder of the project
Build
$npm run build
Test
$npm run test
Lint
$npm run lint