SFDX plugin to interact with Clayton platform.
This plugin needs the following environment variables in order to authenticate calls:
- CLAYTON_CLIENT_ID="client id"
- CLAYTON_CLIENT_SECRET="secret"
- CLAYTON_REFRESH_TOKEN="OAuth2 Refresh Token"
Additionally since every call is towards a workspace you can define your default workspace settings:
- CLAYTON_WORKSPACE_DEFAULT="workspace unique identifier"
$ npm install -g @spaceheroes/sfdx-clayton
$ sfdx COMMAND
running command...
$ sfdx (--version)
@spaceheroes/sfdx-clayton/0.0.4 darwin-arm64 node-v16.14.2
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx clayton:scan:by_branch -b <string> -p <string> -w <string> [--wait <string>] [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx clayton:scan:by_branch_revision -b <string> -p <string> -r <string> -w <string> [--wait <string>] [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx clayton:scan:by_pull_request -p <string> -n <integer> -w <string> [--wait <string>] [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx clayton:scan:get -p <string> -s <string> -w <string> [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx clayton:scan:by_branch -b <string> -p <string> -w <string> [--wait <string>] [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Run a scan of a branch
USAGE
$ sfdx clayton:scan:by_branch -b <string> -p <string> -w <string> [--wait <string>] [--client-id <string>]
[--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-b, --branch=<value> (required) branch name
-p, --project=<value> (required) unique identifier of the
environment or repository
-w, --workspace=<value> (required) unique identifier of the
workspace
--client-id=<value> Clayton client id for OAuth 2.0
authentication
--client-secret=<value> Clayton client secret for OAuth 2.0
authentication
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--refresh-token=<value> Clayton refresh token for OAuth 2.0
authentication
--wait=<value> timeout in minutes for waiting the
scan to be processed ( minimium 5 )
DESCRIPTION
Run a scan of a branch
EXAMPLES
$ sfdx clayton:scan:by_branch --workspace 123 --project 123 --branch main
See code: src/commands/clayton/scan/by_branch.ts
sfdx clayton:scan:by_branch_revision -b <string> -p <string> -r <string> -w <string> [--wait <string>] [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Run a scan of a git revision on a given branch
USAGE
$ sfdx clayton:scan:by_branch_revision -b <string> -p <string> -r <string> -w <string> [--wait <string>] [--client-id <string>]
[--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-b, --branch=<value> (required) branch name
-p, --project=<value> (required) unique identifier of the
environment or repository
-r, --revision=<value> (required) revision SHA
-w, --workspace=<value> (required) unique identifier of the
workspace
--client-id=<value> Clayton client id for OAuth 2.0
authentication
--client-secret=<value> Clayton client secret for OAuth 2.0
authentication
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--refresh-token=<value> Clayton refresh token for OAuth 2.0
authentication
--wait=<value> timeout in minutes for waiting the
scan to be processed ( minimium 5 )
DESCRIPTION
Run a scan of a git revision on a given branch
EXAMPLES
$ sfdx clayton:scan:by_branch_revision --workspace 123 --project 123 --branch main --revision 123
See code: src/commands/clayton/scan/by_branch_revision.ts
sfdx clayton:scan:by_pull_request -p <string> -n <integer> -w <string> [--wait <string>] [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Run a scan of a pull_request
USAGE
$ sfdx clayton:scan:by_pull_request -p <string> -n <integer> -w <string> [--wait <string>] [--client-id <string>]
[--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-n, --pull-request-number=<value> (required) number identifier of the
pull request
-p, --project=<value> (required) unique identifier of the
environment or repository
-w, --workspace=<value> (required) unique identifier of the
workspace
--client-id=<value> Clayton client id for OAuth 2.0
authentication
--client-secret=<value> Clayton client secret for OAuth 2.0
authentication
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--refresh-token=<value> Clayton refresh token for OAuth 2.0
authentication
--wait=<value> timeout in minutes for waiting the
scan to be processed ( minimium 5 )
DESCRIPTION
Run a scan of a pull_request
EXAMPLES
$ sfdx clayton:scan:by_pull_request --workspace 123 --project 123 --pull_request_number 123
See code: src/commands/clayton/scan/by_pull_request.ts
sfdx clayton:scan:get -p <string> -s <string> -w <string> [--client-id <string>] [--client-secret <string>] [--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Fetch a scan report
USAGE
$ sfdx clayton:scan:get -p <string> -s <string> -w <string> [--client-id <string>] [--client-secret <string>]
[--refresh-token <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --project=<value> (required) unique identifier of the
environment or repository
-s, --scan=<value> (required) unique identifier of the
scan
-w, --workspace=<value> (required) unique identifier of the
workspace
--client-id=<value> Clayton client id for OAuth 2.0
authentication
--client-secret=<value> Clayton client secret for OAuth 2.0
authentication
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--refresh-token=<value> Clayton refresh token for OAuth 2.0
authentication
DESCRIPTION
Fetch a scan report
EXAMPLES
$ sfdx clayton:scan --workspace 123 --project 123 --scan 123
See code: src/commands/clayton/scan/get.ts