diff --git a/README.md b/README.md index 0424fab..e3cc660 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,12 @@ # @omniboard/analyzer - ## Getting started with Omniboard in less than 5 minutes (video) - ### Create account, get API key and define checks 1. Create account for [Omniboard.dev](https://www.omniboard.dev) @@ -18,7 +16,6 @@ 4. (optional) test your API key using `npx omniboard test-connection --api-key ` (same as `omniboard tc --ak `) 5. Define checks in the [Omniboard.dev](https://app.omniboard.dev/app/checks) app - ### Run in projects Make sure you have already set `OMNIBOARD_API_KEY` environment variable in the given environment @@ -28,11 +25,11 @@ Make sure you have already set `OMNIBOARD_API_KEY` environment variable in the g or -* `npx @omniboard/analyzer` (in case it was not pre installed) +- `npx @omniboard/analyzer` (in case it was not pre installed) or -* `npm i -g @omniboard/analyzer` - install it globally to be able to run `omniboard` in any path without waiting for npx install +- `npm i -g @omniboard/analyzer` - install it globally to be able to run `omniboard` in any path without waiting for npx install ## Options @@ -45,7 +42,7 @@ Run `omniboard --help` for list of all supported commands and options (`omniboar - `--check-pattern` - only run checks matching provided pattern - `--json` - store data in local json file - `--json-path` - location of local json file - +- `--silent` - silcences the renderer ## How it works @@ -58,6 +55,7 @@ Run `omniboard --help` for list of all supported commands and options (`omniboar ## FAQ #### Is it possible to run @omniboard/analyzer behind organization proxy? + **Yes** The `@omniboard/analyzer` uses [global-agent](https://github.com/gajus/global-agent) library which will uses @@ -65,14 +63,13 @@ The `@omniboard/analyzer` uses [global-agent](https://github.com/gajus/global-ag to `https://api.omniboard.dev` #### Is this uploading my source code to the cloud? + **No** -The `@omniboard/analyzer` runs checks against your source code (or even generated artifacts) -and uploads results of these checks to the cloud service for further processing. +The `@omniboard/analyzer` runs checks against your source code (or even generated artifacts) +and uploads results of these checks to the cloud service for further processing. The uploaded content is then just metadata describing the projects and results but NOT the projects themselves. -In theory, a check which matches everything could be constructed but such result will -be rejected as the payload would be too large. The limits of how much data can be stored +In theory, a check which matches everything could be constructed but such result will +be rejected as the payload would be too large. The limits of how much data can be stored per check and per all checks for a project can be customized in organization settings in the Omniboard.dev app. - - diff --git a/lib/index.ts b/lib/index.ts index 3e92beb..34cbd66 100644 --- a/lib/index.ts +++ b/lib/index.ts @@ -44,6 +44,11 @@ import { loggerMiddleware } from './middlewares/logger.middleware'; description: 'Exit with success (0) even in case of errors and log them as warnings', }) + .option('silent', { + type: 'boolean', + default: false, + description: 'Silences the renderer.', + }) .alias('v', 'version') .alias('h', 'help') .epilogue( diff --git a/lib/interface.ts b/lib/interface.ts index 715afdc..1323be0 100644 --- a/lib/interface.ts +++ b/lib/interface.ts @@ -6,6 +6,7 @@ export interface Options { checkPattern?: string; checkDefinition?: string; apiKey?: string; + silent: boolean; } export interface Context { diff --git a/lib/utils/process.ts b/lib/utils/process.ts index b33e870..8ba7674 100755 --- a/lib/utils/process.ts +++ b/lib/utils/process.ts @@ -22,6 +22,7 @@ export const runner = async ( await new Listr(tasks, { rendererFallback: () => options?.verbose, rendererOptions: { collapse: false, showTimer: true }, + renderer: options.silent ? 'silent' : 'default', }) .run(context) .then((res) => {