1.0.0-alpha • Published 4 years ago

harness-cli v1.0.0-alpha

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

Testing

harness template:exec ./template.json --dest https://github.com/ldhertert/luke-testing-harness.git --var applicationName=Plex --var serviceName=ombi5

todo

  • Configuration/Secrets
  • Logging
  • Error handling
  • Templating
  • Automated build
  • Tests
  • Move to harness github org
  • Validation of user input
  • In memory file system

harness-cli

oclif Version Downloads/week License

Usage

$ npm install -g harness-cli
$ harness COMMAND
running command...
$ harness (-v|--version|version)
harness-cli/1.0.0-alpha darwin-x64 node-v12.18.3
$ harness --help [COMMAND]
USAGE
  $ harness COMMAND
...
$ npm install -g harness-cli
$ harness COMMAND
running command...
$ harness (-v|--version|version)
harness-cli/1.0.0-alpha darwin-x64 node-v12.18.3
$ harness --help [COMMAND]
USAGE
  $ harness COMMAND
...

Commands

harness application:create NAME [DESCRIPTION]

Create a new application

USAGE
  $ harness application:create NAME [DESCRIPTION]

ARGUMENTS
  NAME         The name of the application
  DESCRIPTION  A description of the application

OPTIONS
  --branch=branch                      The branch name to use for git sync
  --gitConnector=gitConnector          The name or id of the git connector to use for git sync
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key
  --syncEnabled                        Whether or not git sync should be enabled

See code: src/commands/application/create.ts

harness application:delete NAMEORID

Delete an application

USAGE
  $ harness application:delete NAMEORID

ARGUMENTS
  NAMEORID  The current name or id of the application

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/application/delete.ts

harness application:get NAMEORID

Get an application

USAGE
  $ harness application:get NAMEORID

ARGUMENTS
  NAMEORID  The name or id of the application

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/application/get.ts

harness application:list

List Applications

USAGE
  $ harness application:list

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/application/list.ts

harness application:update NAMEORID

Update an application

USAGE
  $ harness application:update NAMEORID

ARGUMENTS
  NAMEORID  The current name or id of the application

OPTIONS
  --branch=branch                      The branch name to use for git sync

  --description=description            The new description of the application. If omitted, the value will remain
                                       unchanged.

  --gitConnector=gitConnector          The name or id of the git connector to use for git sync

  --harnessAccountId=harnessAccountId  (required) The Harness Account Id

  --harnessApiKey=harnessApiKey        (required) The Harness API Key

  --name=name                          The new name of the application.  If omitted, the value will remain unchanged.

  --syncEnabled                        Whether or not git sync should be enabled. If omitted, the value will remain
                                       unchanged.

See code: src/commands/application/update.ts

harness cloud-provider:create-k8s NAME

Create a new application

USAGE
  $ harness cloud-provider:create-k8s NAME

ARGUMENTS
  NAME  The name of the application

OPTIONS
  --harnessAccountId=harnessAccountId                    (required) The Harness Account Id
  --harnessApiKey=harnessApiKey                          (required) The Harness API Key

  --inheritFromDelegate=inheritFromDelegate              If true, permissions are inherited from the delegate instead of
                                                         being explicitly provided

  --masterUrl=masterUrl                                  The Kubernetes master node URL. The easiest method to obtain
                                                         the master URL is using kubectl: kubectl cluster-info

  --serviceAccountTokenSecret=serviceAccountTokenSecret  The name or id of the secret that contains the service account
                                                         token

  --skipValidation

See code: src/commands/cloud-provider/create-k8s.ts

harness connectors:create-git NAME URL

Create git connector

USAGE
  $ harness connectors:create-git NAME URL

ARGUMENTS
  NAME  The name of the user
  URL   The url for the repository

OPTIONS
  --branch=branch
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key
  --passwordSecret=passwordSecret      (required)
  --username=username                  (required)

See code: src/commands/connectors/create-git.ts

harness groups:create NAME

Create a new user group. Note - not all functionality has been implemented yet

USAGE
  $ harness groups:create NAME

ARGUMENTS
  NAME  The name of the group

OPTIONS
  --applicationScope=applicationScope      An application id or name.  This will replace any Application Restrictions
                                           with the provided applications.  Multiple values are allowed

  --copyPermissionFrom=copyPermissionFrom  Copy permissions from an existing group.

  --harnessAccountId=harnessAccountId      (required) The Harness Account Id

  --harnessApiKey=harnessApiKey            (required) The Harness API Key

  --permissions=permissions                JSON encoded permissions object

See code: src/commands/groups/create.ts

harness groups:get NAMEORID

Get user groups

USAGE
  $ harness groups:get NAMEORID

ARGUMENTS
  NAMEORID  The name or id of the user group

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/groups/get.ts

harness groups:list

List User groups

USAGE
  $ harness groups:list

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/groups/list.ts

harness help [COMMAND]

display help for harness

USAGE
  $ harness help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

harness secrets:create NAME VALUE

Create a new secret

USAGE
  $ harness secrets:create NAME VALUE

ARGUMENTS
  NAME   The name of the secret
  VALUE  The value of the secret

OPTIONS
  --accountScope
      Scope this secret to the account for use in delegate profiles

  --harnessAccountId=harnessAccountId
      (required) The Harness Account Id

  --harnessApiKey=harnessApiKey
      (required) The Harness API Key

  --scope=scope
      [default: ALL_APPS::PROD_ENVS,ALL_APPS::NON_PROD_ENVS] 
      Restrict the use of this resource to specific Harness components.  
      The expected format is "application::environment".  
      The supported values for applications are "ALL_APPS", an application name, or an application id.  
      The supported values for environments are "PROD_ENVS", "NON_PROD_ENVS", an environment name, or an environment id.

      Examples:
      All applications, production environments: "ALL_APPS::PROD_ENVS"
      All applications, non-production environments: "ALL_APPS::NON_PROD_ENVS"
      Specific application, specific environment: "MyCoolApp::development"
      Specific application, non-production environment: "rPyC0kD_SbymffS26SC_GQ::nonprod"

  --type=(ENCRYPTED_TEXT)
      (required) [default: ENCRYPTED_TEXT]

See code: src/commands/secrets/create.ts

harness template:exec MANIFEST

Apply steps defined in template manifest and send reults to target Harness account

USAGE
  $ harness template:exec MANIFEST

OPTIONS
  -v, --var=var
  --dest=dest          (required)
  --gitToken=gitToken  Token to use for git authentication

See code: src/commands/template/exec.ts

harness users:create EMAIL NAME

Create user

USAGE
  $ harness users:create EMAIL NAME

ARGUMENTS
  EMAIL  The email of the user
  NAME   The name of the user

OPTIONS
  --groups=groups
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/users/create.ts

harness users:get USER

Get users

USAGE
  $ harness users:get USER

ARGUMENTS
  USER  The email, name, or id of the user

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/users/get.ts

harness application:create NAME [DESCRIPTION]

Create a new application

USAGE
  $ harness application:create NAME [DESCRIPTION]

ARGUMENTS
  NAME         The name of the application
  DESCRIPTION  A description of the application

OPTIONS
  --branch=branch                      The branch name to use for git sync
  --gitConnector=gitConnector          The name or id of the git connector to use for git sync
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key
  --syncEnabled                        Whether or not git sync should be enabled

See code: src/commands/application/create.ts

harness application:delete NAMEORID

Delete an application

USAGE
  $ harness application:delete NAMEORID

ARGUMENTS
  NAMEORID  The current name or id of the application

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/application/delete.ts

harness application:get NAMEORID

Get an application

USAGE
  $ harness application:get NAMEORID

ARGUMENTS
  NAMEORID  The name or id of the application

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/application/get.ts

harness application:list

List Applications

USAGE
  $ harness application:list

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/application/list.ts

harness application:update NAMEORID

Update an application

USAGE
  $ harness application:update NAMEORID

ARGUMENTS
  NAMEORID  The current name or id of the application

OPTIONS
  --branch=branch                      The branch name to use for git sync

  --description=description            The new description of the application. If omitted, the value will remain
                                       unchanged.

  --gitConnector=gitConnector          The name or id of the git connector to use for git sync

  --harnessAccountId=harnessAccountId  (required) The Harness Account Id

  --harnessApiKey=harnessApiKey        (required) The Harness API Key

  --name=name                          The new name of the application.  If omitted, the value will remain unchanged.

  --syncEnabled                        Whether or not git sync should be enabled. If omitted, the value will remain
                                       unchanged.

See code: src/commands/application/update.ts

harness cloud-provider:create-k8s NAME

Create a new application

USAGE
  $ harness cloud-provider:create-k8s NAME

ARGUMENTS
  NAME  The name of the application

OPTIONS
  --harnessAccountId=harnessAccountId                    (required) The Harness Account Id
  --harnessApiKey=harnessApiKey                          (required) The Harness API Key

  --inheritFromDelegate=inheritFromDelegate              If true, permissions are inherited from the delegate instead of
                                                         being explicitly provided

  --masterUrl=masterUrl                                  The Kubernetes master node URL. The easiest method to obtain
                                                         the master URL is using kubectl: kubectl cluster-info

  --serviceAccountTokenSecret=serviceAccountTokenSecret  The name or id of the secret that contains the service account
                                                         token

  --skipValidation

See code: src/commands/cloud-provider/create-k8s.ts

harness groups:create NAME

Create a new user group. Note - not all functionality has been implemented yet

USAGE
  $ harness groups:create NAME

ARGUMENTS
  NAME  The name of the group

OPTIONS
  --applicationScope=applicationScope      An application id or name.  This will replace any Application Restrictions
                                           with the provided applications.  Multiple values are allowed

  --copyPermissionFrom=copyPermissionFrom  Copy permissions from an existing group.

  --harnessAccountId=harnessAccountId      (required) The Harness Account Id

  --harnessApiKey=harnessApiKey            (required) The Harness API Key

  --permissions=permissions                JSON encoded permissions object

See code: src/commands/groups/create.ts

harness groups:get NAMEORID

Get user groups

USAGE
  $ harness groups:get NAMEORID

ARGUMENTS
  NAMEORID  The name or id of the user group

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/groups/get.ts

harness groups:list

List User groups

USAGE
  $ harness groups:list

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/groups/list.ts

harness help [COMMAND]

display help for harness

USAGE
  $ harness help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

harness secrets:create NAME VALUE

Create a new secret

USAGE
  $ harness secrets:create NAME VALUE

ARGUMENTS
  NAME   The name of the secret
  VALUE  The value of the secret

OPTIONS
  --accountScope
      Scope this secret to the account for use in delegate profiles

  --harnessAccountId=harnessAccountId
      (required) The Harness Account Id

  --harnessApiKey=harnessApiKey
      (required) The Harness API Key

  --scope=scope
      [default: ALL_APPS::PROD_ENVS,ALL_APPS::NON_PROD_ENVS] 
      Restrict the use of this resource to specific Harness components.  
      The expected format is "application::environment".  
      The supported values for applications are "ALL_APPS", an application name, or an application id.  
      The supported values for environments are "PROD_ENVS", "NON_PROD_ENVS", an environment name, or an environment id.

      Examples:
      All applications, production environments: "ALL_APPS::PROD_ENVS"
      All applications, non-production environments: "ALL_APPS::NON_PROD_ENVS"
      Specific application, specific environment: "MyCoolApp::development"
      Specific application, non-production environment: "rPyC0kD_SbymffS26SC_GQ::nonprod"

  --type=(ENCRYPTED_TEXT)
      (required) [default: ENCRYPTED_TEXT]

See code: src/commands/secrets/create.ts

harness template:exec MANIFEST

Apply steps defined in template manifest and send reults to target Harness account

USAGE
  $ harness template:exec MANIFEST

OPTIONS
  -v, --var=var
  --dest=dest          (required)
  --gitToken=gitToken  Token to use for git authentication

See code: src/commands/template/exec.ts

harness users:create EMAIL NAME

Create user

USAGE
  $ harness users:create EMAIL NAME

ARGUMENTS
  EMAIL  The email of the user
  NAME   The name of the user

OPTIONS
  --groups=groups
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/users/create.ts

harness users:get USER

Get users

USAGE
  $ harness users:get USER

ARGUMENTS
  USER  The email, name, or id of the user

OPTIONS
  --harnessAccountId=harnessAccountId  (required) The Harness Account Id
  --harnessApiKey=harnessApiKey        (required) The Harness API Key

See code: src/commands/users/get.ts

oclif
@oclif/command@oclif/config@oclif/plugin-helpaxiosform-dataglobisomorphic-gitjs-yamljsziplodashminimatchtslib
1.0.0-alpha

4 years ago