proxyclick-cli v0.0.36

@proxyclick/cli

Toolset of useful scripts for happy users

• @proxyclick/cli
• Usage
• Commands

Usage

$ npm install -g proxyclick-cli
$ proxyclick COMMAND
running command...
$ proxyclick (-v|--version|version)
proxyclick-cli/0.0.36 darwin-x64 node-v10.13.0
$ proxyclick --help [COMMAND]
USAGE
  $ proxyclick COMMAND
...

Commands

• proxyclick autocomplete [SHELL]
• proxyclick batch-execute CONFIGFILE
• proxyclick copy-agreements SOURCE DESTINATION
• proxyclick copy-badge SOURCE DESTINATION
• proxyclick copy-checkin-flow SOURCE DESTINATION
• proxyclick copy-rr-settings SOURCE DESTINATION
• proxyclick copy-translations SOURCE DESTINATION
• proxyclick copy-user-rights-groups SOURCE DESTINATION
• proxyclick downgrade-billing COMPANYID PLAN
• proxyclick enable-employee COMPANYID
• proxyclick help [COMMAND]
• proxyclick replace-agreements SOURCE DESTINATION
• proxyclick setup
• proxyclick soft-delete TARGET FLAGUSER
• proxyclick user-info USERID

proxyclick autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ proxyclick autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ proxyclick autocomplete
  $ proxyclick autocomplete bash
  $ proxyclick autocomplete zsh
  $ proxyclick autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

proxyclick batch-execute CONFIGFILE

Executes multiple commands for mutliple locations in a batch.

USAGE
  $ proxyclick batch-execute CONFIGFILE

ARGUMENTS
  CONFIGFILE  The JSON file containing commands to execute

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  Executes multiple commands for mutliple locations in a batch.

  To set up the batch execute you need to provide a json file that will be validated against the 
  [batch-execute.schema.json]. The batch file has 2 sections: [companyIds] and [commands]:
     * companyIds - an array of company ID's which will be looped
     * commands - the commands that will be run for each companyId from the previous section. Concrete values need to be 
  provided for all arguments required by a specific command. The special wildcard '*' can be used which will be replaced 
  be the companyId that is being looped.

  Here is an example file which will enable employee features and copy the badge for the two companies CO-B101 and 
  CO-C202:

  {
     "$schema": "./batch-execute.schema.json",
     "companyIds": [
       "CO-B101",
       "CO-C202"
     ],
     "commands": {
       "enable-employee": {
         "companyId": "*"
       },
       "copy-badge": {
         "source": "CO-D404",
         "destination": "*"
       }
     }
  }

EXAMPLE
  $ proxyclick batch-execute commands.json

See code: src/commands/batch-execute.ts

proxyclick copy-agreements SOURCE DESTINATION

Copy agreements from one location to another.

USAGE
  $ proxyclick copy-agreements SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  The following entities will be copied :
    - Custom fields used in agreement
    - Languages variants (if exist in destination)
    - Custom images
    - Conditions
    - Validity settings
    - Visitor options
 
    Please note that existing agreements on target location are untouched.

    Use this if you want to use both destination + source agreements 
    (this may require adding conditions on copied agreements afterwards, because existing agreements will still be on 
  top of the list).
 
    Also to avoid duplicated agreements, we do not copy agreements that are equals (if every properties are the same but 
  the name).
    If an agreement with same name exists in source and destination, a suffix is added (copy-1), (copy-2), ...

EXAMPLE
  $ proxyclick copy-agreements CO-B101 CO-C202

See code: src/commands/copy-agreements.ts

proxyclick copy-badge SOURCE DESTINATION

Copy the badge from one location to another location.

USAGE
  $ proxyclick copy-badge SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ proxyclick copy-badge CO-B101 CO-C202

See code: src/commands/copy-badge.ts

proxyclick copy-checkin-flow SOURCE DESTINATION

Copy kiosk checkin flow from one location to another.

USAGE
  $ proxyclick copy-checkin-flow SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  The following entities will be copied :
     - Custom fields (only the ones needed for the check-in flow)
     - Custom kiosk checkin flow

EXAMPLE
  $ proxyclick copy-checkin-flow CO-B101 CO-C202

See code: src/commands/copy-checkin-flow.ts

proxyclick copy-rr-settings SOURCE DESTINATION

Copy remote registration settings from one location to another.

USAGE
  $ proxyclick copy-rr-settings SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  The following entities will be copied :
     - Remote registration related vm params (
       + preCheckIn
       + visitorCheckEnabled
       + maxCustomFields
       + visitorCheckSingleTriggerTime
       + visitorCheckSingleReminderTime
       + visitorCheckRecurrentTriggerTime
       + visitorCheckRecurrentReminderTime
     - Visitor check emails params
     - Custom fields (only the ones needed for the remote registration flow)
     - Remote registration flow

  Please note that if the destination already has a remote registration flow, it will be
  replaced by the origin one and the custom fields that were only used in the old destination
  remote registration flow will be deleted (to avoid reaching max custom fields limit).

EXAMPLE
  $ proxyclick copy-rr-settings CO-B101 CO-C202

See code: src/commands/copy-rr-settings.ts

proxyclick copy-translations SOURCE DESTINATION

Copy the translations used in the kiosk & remote registration app.

USAGE
  $ proxyclick copy-translations SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help           show CLI help
  -l, --copyLanguages  Copy all source languages to the destination

EXAMPLE
  $ proxyclick copy-translations CO-B101 CO-C202

See code: src/commands/copy-translations.ts

proxyclick copy-user-rights-groups SOURCE DESTINATION

Copy user rights groups from one location to another location.

USAGE
  $ proxyclick copy-user-rights-groups SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ proxyclick copy-user-rights-groups CO-B101 CO-C202

See code: src/commands/copy-user-rights-groups.ts

proxyclick downgrade-billing COMPANYID PLAN

Downgrade a company to an old pricing plan.

USAGE
  $ proxyclick downgrade-billing COMPANYID PLAN

ARGUMENTS
  COMPANYID  The company id (CO-) to downgrade. The current billing status has to be IN_TRIAL

  PLAN       (vm_features_small_2014_11|vm_features_medium_2014_11|vm_features_large_2014_11|vm_features_enterprise_2014
             _11|vm_features_custom_2014_12|vm_features_small_2015_09|vm_features_promo_small_2015_09|vm_features_promo_
             medium_2015_09|vm_features_free_2016_03|vm_features_medium_2016_03|vm_features_large_2016_03|vm_features_en
             terprise_2016_03|vm_features_medium_2017_09|vm_features_tenant_2018_04|vm_features_medium_2020_03|vm_featur
             es_large_2020_03) The reference of the old plan

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ proxyclick downgrade-billing CO-B101 vm_features_medium_2017_09

See code: src/commands/downgrade-billing.ts

proxyclick enable-employee COMPANYID

Enables employee features for a company

USAGE
  $ proxyclick enable-employee COMPANYID

ARGUMENTS
  COMPANYID  The target company id (e.g. CO-B101)

OPTIONS
  -h, --help            show CLI help
  --bookingEnabled
  --deskBookingEnabled
  --occupancyEnabled

EXAMPLE
  $ proxyclick enable-employee CO-B101

See code: src/commands/enable-employee.ts

proxyclick help [COMMAND]

display help for proxyclick

USAGE
  $ proxyclick help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

proxyclick replace-agreements SOURCE DESTINATION

Replace agreements from one location to another (drop all existing agreements in destination and replace them by the source ones)

USAGE
  $ proxyclick replace-agreements SOURCE DESTINATION

ARGUMENTS
  SOURCE       The source company id (e.g. CO-B101)
  DESTINATION  The destination company id (e.g. CO-C202)

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  This is a DESTRUCTIVE operation. Please use cautiously.

    The following entities will be copied :
    - Custom fields used in agreement
    - Languages variants (if exist in destination)
    - Custom images
    - Conditions
    - Validity settings
    - Visitor options

EXAMPLE
  $ proxyclick replace-agreements CO-B101 CO-C202

See code: src/commands/replace-agreements.ts

proxyclick setup

Setup configuration environments

USAGE
  $ proxyclick setup

EXAMPLE
  $ proxyclick setup

See code: src/commands/setup.ts

proxyclick soft-delete TARGET FLAGUSER

Mark provided location for later hard delete.

USAGE
  $ proxyclick soft-delete TARGET FLAGUSER

ARGUMENTS
  TARGET    The target company id (e.g. CO-B101)

  FLAGUSER  [default: US-PAWCY830] The flag user id (e.g. US-PAWCY830) that will become the new default host of the
            deleted company

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  The following steps will be performed:
       - Deleted Companies user US-PAWCY830 added to location
         + Added to Administrators rights group
         + Set as Default Host
       - Company Name updated, appending ' (TO DELETE)'
       - Remove all other users from account
       - Teardown integrations
         + SCIM

EXAMPLE
  $ proxyclick soft-delete CO-B101

See code: src/commands/soft-delete.ts

proxyclick user-info USERID

Gets info for a user

USAGE
  $ proxyclick user-info USERID

ARGUMENTS
  USERID  The user id

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ proxyclick user-info US-B101

See code: src/commands/user-info.ts