Skip to content

Commit

Permalink
docs(command-docs): update command docs
Browse files Browse the repository at this point in the history
  • Loading branch information
azlam-abdulsalam committed Mar 6, 2024
1 parent e1affe3 commit 83154c8
Show file tree
Hide file tree
Showing 19 changed files with 139 additions and 137 deletions.
14 changes: 7 additions & 7 deletions packages/sfp-cli/command-docs/apextests.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
`@flxbl-io/sfp apextests`
========================
=========================

Manage apex tests in a package or a org

* [`@flxbl-io/sfp apextests trigger`](#flxbliosfp-apextests-trigger)
* [`@flxbl-io/sfp apextests trigger`](#flxbl-iosfp-apextests-trigger)

## `@flxbl-io/sfp apextests trigger`

Triggers Apex unit test in an org. Supports test level RunAllTestsInPackage, which optionally allows validation of individual class code coverage

```
USAGE
$ @flxbl-io/sfp apextests trigger -u <value> [--loglevel
$ @flxbl-io/sfp apextests trigger -o <value> [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [--apiversion <value>] [-l
RunSpecifiedTests|RunApexTestSuite|RunLocalTests|RunAllTestsInOrg|RunAllTestsInPackage] [-n <value>] [-c]
[--validatepackagecoverage] [--specifiedtests <value>] [--apextestsuite <value>] [-p <value>] [-w <value>]
Expand All @@ -26,9 +26,9 @@ FLAGS
AllTestsInPackage>
-n, --package=<value> Name of the package to run tests. Required when test level is
RunAllTestsInPackage
-o, --targetusername=<value> (required) Username or alias of the target org.
-p, --coveragepercent=<value> [default: 75] Minimum required percentage coverage, when validating code
coverage
-u, --targetusername=<value> (required) Username or alias of the target org.
-w, --waittime=<value> [default: 60] wait time for command to finish in minutes
--apextestsuite=<value> comma-separated list of Apex test suite names to run
--apiversion=<value> Override the api version used for api requests made by this command
Expand All @@ -44,9 +44,9 @@ DESCRIPTION
individual class code coverage
EXAMPLES
$ sfp apextests:trigger -u scratchorg -l RunLocalTests -s
$ sfp apextests:trigger -o scratchorg -l RunLocalTests -s
$ sfp apextests:trigger -u scratchorg -l RunAllTestsInPackage -n <mypackage> -c
$ sfp apextests:trigger -o scratchorg -l RunAllTestsInPackage -n <mypackage> -c
```

_See code: [src/commands/apextests/trigger.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/apextests/trigger.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/apextests/trigger.ts)_
20 changes: 10 additions & 10 deletions packages/sfp-cli/command-docs/artifacts.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
`@flxbl-io/sfp artifacts`
========================
=========================

Manage artifacts for a project

* [`@flxbl-io/sfp artifacts fetch`](#flxbliosfp-artifacts-fetch)
* [`@flxbl-io/sfp artifacts promote`](#flxbliosfp-artifacts-promote)
* [`@flxbl-io/sfp artifacts query`](#flxbliosfp-artifacts-query)
* [`@flxbl-io/sfp artifacts fetch`](#flxbl-iosfp-artifacts-fetch)
* [`@flxbl-io/sfp artifacts promote`](#flxbl-iosfp-artifacts-promote)
* [`@flxbl-io/sfp artifacts query`](#flxbl-iosfp-artifacts-query)

## `@flxbl-io/sfp artifacts fetch`

Expand Down Expand Up @@ -37,7 +37,7 @@ EXAMPLES
$ sfp artifacts:fetch -p myreleasedefinition.yaml --npm --scope myscope --npmrcpath path/to/.npmrc
```

_See code: [src/commands/artifacts/fetch.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/artifacts/fetch.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/artifacts/fetch.ts)_

## `@flxbl-io/sfp artifacts promote`

Expand All @@ -64,19 +64,19 @@ EXAMPLES
$ sfp promote -d path/to/artifacts -v <org>
```

_See code: [src/commands/artifacts/promote.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/artifacts/promote.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/artifacts/promote.ts)_

## `@flxbl-io/sfp artifacts query`

Fetch details about artifacts installed in a target org

```
USAGE
$ @flxbl-io/sfp artifacts query -u <value> [--json] [--loglevel
$ @flxbl-io/sfp artifacts query -o <value> [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-u, --targetusername=<value> (required) Username or alias of the target org.
-o, --targetusername=<value> (required) Username or alias of the target org.
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
Expand All @@ -87,7 +87,7 @@ DESCRIPTION
Fetch details about artifacts installed in a target org
EXAMPLES
$ sfp artifacts:query -u <target_org>
$ sfp artifacts:query -o <target_org>
```

_See code: [src/commands/artifacts/query.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/artifacts/query.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/artifacts/query.ts)_
9 changes: 5 additions & 4 deletions packages/sfp-cli/command-docs/build.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
`@flxbl-io/sfp build`
====================
=====================

Build artifact(s) of your packages in the current project

* [`@flxbl-io/sfp build`](#flxbliosfp-build)
* [`@flxbl-io/sfp build`](#flxbl-iosfp-build)

## `@flxbl-io/sfp build`

Expand All @@ -19,7 +19,8 @@ USAGE
FLAGS
-f, --configfilepath=<value> [default: config/project-scratch-def.json] Path in the current project directory
containing config file for the packaging org
-p, --buildOnly=<value>... Only build artifacts for the provided packages, comma separated list of package names
-p, --buildOnly=<value>... Only build artifacts for the provided package names,use comma separated list of
package names if there are multiple packages
-r, --repourl=<value> Custom source repository URL to use in artifact metadata, overrides origin URL defined
in git config
-v, --devhubalias=<value> (required) Username or alias of the Dev Hub org.
Expand All @@ -44,4 +45,4 @@ ALIASES
$ @flxbl-io/sfp orchestrator build
```

_See code: [src/commands/build.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/build.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/build.ts)_
12 changes: 5 additions & 7 deletions packages/sfp-cli/command-docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
`@flxbl-io/sfp changelog`
========================
=========================

Track your artifacts & user stories as they progress through different environments, with release changelogs

* [`@flxbl-io/sfp changelog generate`](#flxbliosfp-changelog-generate)
* [`@flxbl-io/sfp changelog generate`](#flxbl-iosfp-changelog-generate)

## `@flxbl-io/sfp changelog generate`

Generates release changelog, providing a summary of artifact versions, work items and commits introduced in a release. Creates a release definition based on artifacts contained in the artifact directory, and compares it to previous release definition in changelog stored on a source repository

```
USAGE
$ @flxbl-io/sfp changelog generate -d <value> -n <value> -w <value> [--limit <value>] [--workitemurl <value>] [-r
<value>] [--directory <value>] (--nopush -b <value>) [--showallartifacts] [--loglevel
$ @flxbl-io/sfp changelog generate -d <value> -n <value> -w <value> [--limit <value>] [--workitemurl <value>]
[--directory <value>] (--nopush -b <value>) [--showallartifacts] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-b, --branchname=<value> (required) Repository branch in which the changelog files are located
-d, --artifactdir=<value> (required) [default: artifacts] Directory containing sfp artifacts
-n, --releasename=<value> (required) Name of the release for which to generate changelog
-r, --repourl=<value> Repository in which the changelog files are located. Assumes user is already
authenticated.
-w, --workitemfilter=<value> (required) Regular expression used to search for work items (user stories) introduced in
release
--directory=<value> Relative path to directory to which the release defintion file should be generated, if
Expand All @@ -43,4 +41,4 @@ EXAMPLES
$ sfp changelog:generate -n <releaseName> -d path/to/artifact/directory -w <regexp> -r <repoURL> -b <branchName>
```

_See code: [src/commands/changelog/generate.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/changelog/generate.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/changelog/generate.ts)_
6 changes: 3 additions & 3 deletions packages/sfp-cli/command-docs/commands.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
`@flxbl-io/sfp commands`
=======================
========================

list all the commands

* [`@flxbl-io/sfp commands`](#flxbliosfp-commands)
* [`@flxbl-io/sfp commands`](#flxbl-iosfp-commands)

## `@flxbl-io/sfp commands`

Expand Down Expand Up @@ -35,4 +35,4 @@ DESCRIPTION
list all the commands
```

_See code: [@oclif/plugin-commands](https://github.com/flxbl-io/sfp)_
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v3.0.3/src/commands/commands.ts)_
18 changes: 9 additions & 9 deletions packages/sfp-cli/command-docs/dependency.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
`@flxbl-io/sfp dependency`
=========================
==========================

Manage the dependencies of a project

* [`@flxbl-io/sfp dependency expand`](#flxbliosfp-dependency-expand)
* [`@flxbl-io/sfp dependency install`](#flxbliosfp-dependency-install)
* [`@flxbl-io/sfp dependency shrink`](#flxbliosfp-dependency-shrink)
* [`@flxbl-io/sfp dependency expand`](#flxbl-iosfp-dependency-expand)
* [`@flxbl-io/sfp dependency install`](#flxbl-iosfp-dependency-install)
* [`@flxbl-io/sfp dependency shrink`](#flxbl-iosfp-dependency-shrink)

## `@flxbl-io/sfp dependency expand`

Expand All @@ -27,21 +27,21 @@ DESCRIPTION
packages
```

_See code: [src/commands/dependency/expand.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/dependency/expand.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/dependency/expand.ts)_

## `@flxbl-io/sfp dependency install`

Install all the external dependencies of a given project

```
USAGE
$ @flxbl-io/sfp dependency install -u <value> -v <value> [-k <value>] [--loglevel
$ @flxbl-io/sfp dependency install -o <value> -v <value> [-k <value>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-k, --installationkeys=<value> Installation key for key-protected packages (format is packagename:key -->
core:key nCino:key vlocity:key to allow some packages without installation key)
-u, --targetusername=<value> (required) Username or alias of the target org.
-o, --targetusername=<value> (required) Username or alias of the target org.
-v, --targetdevhubusername=<value> (required) Username or alias of the Dev Hub org.
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
Expand All @@ -50,7 +50,7 @@ DESCRIPTION
Install all the external dependencies of a given project
```

_See code: [src/commands/dependency/install.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/dependency/install.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/dependency/install.ts)_

## `@flxbl-io/sfp dependency shrink`

Expand All @@ -72,4 +72,4 @@ DESCRIPTION
exist in its dependent packages
```

_See code: [src/commands/dependency/shrink.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/dependency/shrink.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/dependency/shrink.ts)_
26 changes: 13 additions & 13 deletions packages/sfp-cli/command-docs/flow.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,74 @@
`@flxbl-io/sfp flow`
===================
====================

Manage flows in your org

* [`@flxbl-io/sfp flow activate`](#flxbliosfp-flow-activate)
* [`@flxbl-io/sfp flow cleanup`](#flxbliosfp-flow-cleanup)
* [`@flxbl-io/sfp flow deactivate`](#flxbliosfp-flow-deactivate)
* [`@flxbl-io/sfp flow activate`](#flxbl-iosfp-flow-activate)
* [`@flxbl-io/sfp flow cleanup`](#flxbl-iosfp-flow-cleanup)
* [`@flxbl-io/sfp flow deactivate`](#flxbl-iosfp-flow-deactivate)

## `@flxbl-io/sfp flow activate`

Activate the flow on a target org

```
USAGE
$ @flxbl-io/sfp flow activate -u <value> [-f <value>] [-p <value>] [--loglevel
$ @flxbl-io/sfp flow activate -o <value> [-f <value>] [-p <value>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-f, --developername=<value> The developer name of the flow
-o, --targetorg=<value> (required) Username or alias of the target org.
-p, --namespaceprefix=<value> Use to specify a specific namespace prefix
-u, --targetorg=<value> (required) Username or alias of the target org.
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
DESCRIPTION
Activate the flow on a target org
```

_See code: [src/commands/flow/activate.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/flow/activate.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/flow/activate.ts)_

## `@flxbl-io/sfp flow cleanup`

Cleanup inactive flows on a target org

```
USAGE
$ @flxbl-io/sfp flow cleanup -u <value> [-f <value>] [-p <value>] [--loglevel
$ @flxbl-io/sfp flow cleanup -o <value> [-f <value>] [-p <value>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-f, --developername=<value> The developer name of the flow
-o, --targetorg=<value> (required) Username or alias of the target org.
-p, --namespaceprefix=<value> Use to specify a specific namespace prefix
-u, --targetorg=<value> (required) Username or alias of the target org.
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
DESCRIPTION
Cleanup inactive flows on a target org
```

_See code: [src/commands/flow/cleanup.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/flow/cleanup.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/flow/cleanup.ts)_

## `@flxbl-io/sfp flow deactivate`

Deactivate the flow on a target org

```
USAGE
$ @flxbl-io/sfp flow deactivate -u <value> [-f <value>] [-p <value>] [--loglevel
$ @flxbl-io/sfp flow deactivate -o <value> [-f <value>] [-p <value>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-f, --developername=<value> The developer name of the flow
-o, --targetorg=<value> (required) Username or alias of the target org.
-p, --namespaceprefix=<value> Use to specify a specific namespace prefix
-u, --targetorg=<value> (required) Username or alias of the target org.
--loglevel=<option> [default: info] logging level for this command invocation
<options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
DESCRIPTION
Deactivate the flow on a target org
```

_See code: [src/commands/flow/deactivate.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/flow/deactivate.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/flow/deactivate.ts)_
6 changes: 3 additions & 3 deletions packages/sfp-cli/command-docs/help.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
`@flxbl-io/sfp help`
===================
====================

Display help for @flxbl-io/sfp.

* [`@flxbl-io/sfp help [COMMANDS]`](#flxbliosfp-help-commands)
* [`@flxbl-io/sfp help [COMMANDS]`](#flxbl-iosfp-help-commands)

## `@flxbl-io/sfp help [COMMANDS]`

Expand All @@ -23,4 +23,4 @@ DESCRIPTION
Display help for @flxbl-io/sfp.
```

_See code: [@oclif/plugin-help](https://github.com/flxbl-io/sfp)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.17/src/commands/help.ts)_
10 changes: 5 additions & 5 deletions packages/sfp-cli/command-docs/impact.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
`@flxbl-io/sfp impact`
=====================
======================

Utilities to help you understand the impact of various components in sfp

* [`@flxbl-io/sfp impact package`](#flxbliosfp-impact-package)
* [`@flxbl-io/sfp impact releaseconfig`](#flxbliosfp-impact-releaseconfig)
* [`@flxbl-io/sfp impact package`](#flxbl-iosfp-impact-package)
* [`@flxbl-io/sfp impact releaseconfig`](#flxbl-iosfp-impact-releaseconfig)

## `@flxbl-io/sfp impact package`

Expand All @@ -24,7 +24,7 @@ DESCRIPTION
Figures out impacted packages of a project, due to a change from the last known tags
```

_See code: [src/commands/impact/package.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/impact/package.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/impact/package.ts)_

## `@flxbl-io/sfp impact releaseconfig`

Expand All @@ -50,4 +50,4 @@ DESCRIPTION
Figures out impacted release configurations of a project, due to a change,from the last known tags
```

_See code: [src/commands/impact/releaseconfig.ts](https://github.com/flxbl-io/sfp)_
_See code: [src/commands/impact/releaseconfig.ts](https://github.com/flxbl-io/sfp/blob/v37.0.1/src/commands/impact/releaseconfig.ts)_
Loading

0 comments on commit 83154c8

Please sign in to comment.