sif-cli

The SIF Command Line Interface (sif-cli) is an open-source tool that empowers you to interact with SIF components through commands in your command-line shell. With minimal configuration, sif-cli simplifies many of the complexities associated with managing SIF. Additionally, it incorporates various functionalities to ensure compatibility between your deployed version and the latest release of SIF.

Refer to the SIF Repository for a detailed walkthrough.

Usage
Commands

Usage

$ npm install -g @sif/cli
$ sif COMMAND
running command...
$ sif (--version)
@sif/cli/1.0.0 darwin-x64 node-v18.18.2
$ sif --help [COMMAND]
USAGE
  $ sif COMMAND
...

Commands

sif core build
sif core clone
sif core releases
sif core switch
sif core version
sif environment configure
sif environment delete
sif environment install
sif environment list
sif environment upgrade
sif environment version
sif help [COMMANDS]
sif init
sif instance auth
sif instance configure
sif instance delete
sif instance insomnia
sif instance install
sif instance list
sif instance postman
sif instance start
sif instance upgrade
sif plugins
sif plugins:install PLUGIN...
sif plugins:inspect PLUGIN...
sif plugins:install PLUGIN...
sif plugins:link PLUGIN
sif plugins:uninstall PLUGIN...
sif plugins reset
sif plugins:uninstall PLUGIN...
sif plugins:uninstall PLUGIN...
sif plugins update

`sif core build`

Performs incremental build of all SIF modules

USAGE
  $ sif core build

DESCRIPTION
  Performs incremental build of all SIF modules

EXAMPLES
  $ sif core build

See code: src/commands/core/build.ts

`sif core clone`

Clone SIF into current folder

USAGE
  $ sif core clone [-r <value>]

FLAGS
  -r, --repositoryUrl=<value>  Url of sif repository

DESCRIPTION
  Clone SIF into current folder

EXAMPLES
  $ sif core clone -r https://github.com/aws-solutions-library-samples/guidance-for-aws-sustainability-insights-framework

  $ sif core clone

See code: src/commands/core/clone.ts

`sif core releases`

Listing the existing tags in the SIF repository

USAGE
  $ sif core releases

DESCRIPTION
  Listing the existing tags in the SIF repository

EXAMPLES
  $ sif core releases

See code: src/commands/core/releases.ts

`sif core switch`

Switch the local SIF repository to the specified RELEASE, BRANCH or COMMIT ID

USAGE
  $ sif core switch [-c <value> | [-r <value> | -b <value> | ] | ]

FLAGS
  -b, --branch=<value>    SIF repository branch
  -c, --commitId=<value>  SIF revision commit hash
  -r, --release=<value>   SIF release version

DESCRIPTION
  Switch the local SIF repository to the specified RELEASE, BRANCH or COMMIT ID

EXAMPLES
  $ sif core switch -b main

  $ sif core switch -c ead2b1d

  $ sif core switch -r v1.7.1

  $ sif core switch -r LATEST

See code: src/commands/core/switch.ts

`sif core version`

Print the release tag currently checked out. If there is no release tag, show the branch and commit id

USAGE
  $ sif core version

DESCRIPTION
  Print the release tag currently checked out. If there is no release tag, show the branch and commit id

EXAMPLES
  $ sif core version

See code: src/commands/core/version.ts

`sif environment configure`

Modify SIF configuration for the specified environment

USAGE
  $ sif environment configure -e <value> [-r <value>] [-l <value>] [-h -c <value>]

FLAGS
  -c, --config=<value>       Path to configuration file used for deployment
  -e, --environment=<value>  (required) An environment represents an isolated deployment of tenantId(s)
  -h, --headless             If provided, you also need to specify the path configuration file using -c
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands

DESCRIPTION
  Modify SIF configuration for the specified environment

EXAMPLES
  $ sif environment configure -e stage

  $ sif environment configure -e stage -h -c <PATH_TO_CONFIG_FILE>

See code: src/commands/environment/configure.ts

`sif environment delete`

Delete SIF environment

USAGE
  $ sif environment delete -e <value> [-r <value>] [-l <value>] [-f]

FLAGS
  -e, --environment=<value>  (required) An environment represents an isolated deployment of tenantId(s)
  -f, --force                If specified, will also delete all tenants on the environment
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands

DESCRIPTION
  Delete SIF environment

EXAMPLES
  $ sif environment delete -e stage

  $ sif environment delete -e stage --force

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

`sif environment install`

Install SIF for the specified environment

USAGE
  $ sif environment install -e <value> [-r <value>] [-l <value>] [-h -c <value>]

FLAGS
  -c, --config=<value>       Path to configuration file used for environment upgrade
  -e, --environment=<value>  (required) An environment represents an isolated deployment of tenantId(s)
  -h, --headless             Perform SIF environment upgrade in headless mode, if specified you also need to specify the
                             configuration file
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands

DESCRIPTION
  Install SIF for the specified environment

EXAMPLES
  $ sif environment install -e stage

  $ sif environment install -e stage -h -c <PATH_TO_CONFIG_FILE>

See code: src/commands/environment/install.ts

`sif environment list`

List SIF installed environments

USAGE
  $ sif environment list

DESCRIPTION
  List SIF installed environments

EXAMPLES
  $ sif environment list

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

`sif environment upgrade`

Perform upgrade of SIF environment version

USAGE
  $ sif environment upgrade -e <value> [-r <value>] [-l <value>] [-u <value>] [-h -c <value>]

FLAGS
  -c, --config=<value>          Path to configuration file used for environment upgrade
  -e, --environment=<value>     (required) An environment represents an isolated deployment of tenantId(s)
  -h, --headless                Perform SIF environment upgrade in headless mode, if specified you also need to specify
                                the configuration file
  -l, --role=<value>            The RoleArn for the CLI to assume for deployment
  -r, --region=<value>          AWS region used when running the subcommands
  -u, --upgradeTenants=<value>  Upgrade all tenants to match the local version

DESCRIPTION
  Perform upgrade of SIF environment version

EXAMPLES
  $ sif environment upgrade -e stage

  $ sif environment upgrade -e stage -h -c <PATH_TO_CONFIG_FILE>

See code: src/commands/environment/upgrade.ts

`sif environment version`

Return the version of deployed environment

USAGE
  $ sif environment version -e <value> [-r <value>] [-l <value>]

FLAGS
  -e, --environment=<value>  (required) An environment represents an isolated deployment of tenantId(s)
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands

DESCRIPTION
  Return the version of deployed environment

EXAMPLES
  $ sif environment version -e stage

See code: src/commands/environment/version.ts

`sif help [COMMANDS]`

Display help for sif.

USAGE
  $ sif help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for sif.

See code: @oclif/plugin-help

`sif init`

Install SIF dependencies

USAGE
  $ sif init [-p <value>]

FLAGS
  -p, --projectPath=<value>  path of the sif core project to be used when you are not directly cloning

DESCRIPTION
  Install SIF dependencies

EXAMPLES
  $ sif init

See code: src/commands/init/index.ts

`sif instance auth`

Walks the user through the authentication process to get a JWT token to be used for API calls.

USAGE
  $ sif instance auth -e <value> -t <value> -u <value> -p <value> [-r <value>] [-l <value>] [-n <value>]

FLAGS
  -e, --environment=<value>  (required) The environment to authenticate against
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -n, --newPassword=<value>  The new password to be set for the user
  -p, --password=<value>     (required) The password of the user
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The id of the tenant to authenticate against
  -u, --username=<value>     (required) The username to generate the token for

DESCRIPTION
  Walks the user through the authentication process to get a JWT token to be used for API calls.

EXAMPLES
  $ sif instance auth -t demo -e prod -r us-west-2 -u username -p password

  $ sif instance auth -t demo -e prod -r us-west-2 -u username -p password -n newPassword

See code: src/commands/instance/auth.ts

`sif instance configure`

Redeploys the same instance version.

USAGE
  $ sif instance configure -e <value> -t <value> [-r <value>] [-l <value>] [-h -c <value>]

FLAGS
  -c, --config=<value>       Path to configuration file used for deployment
  -e, --environment=<value>  (required) The environment to redeploy the same instance version to
  -h, --headless             If provided, bypass the questions. You will also need to specify the path configuration
                             file using -c
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The id of the tenant to redeploy

DESCRIPTION
  Redeploys the same instance version.

EXAMPLES
  $ sif instance configure -t demo -e prod -r us-west-2

See code: src/commands/instance/configure.ts

`sif instance delete`

Delete the sif tenant.

USAGE
  $ sif instance delete -e <value> -t <value> [-r <value>] [-l <value>]

FLAGS
  -e, --environment=<value>  (required) The environment to delete the tenant from
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The id of the tenant to delete

DESCRIPTION
  Delete the sif tenant.

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

`sif instance insomnia`

Walks the user through the process to generate the insomnia environment file.

USAGE
  $ sif instance insomnia -e <value> -t <value> [-r <value>] [-l <value>]

FLAGS
  -e, --environment=<value>  (required) The environment used to generate the insomnia environment file
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The id of the tenant used to generate the insomnia environment file

DESCRIPTION
  Walks the user through the process to generate the insomnia environment file.

See code: src/commands/instance/insomnia.ts

`sif instance install`

Walks the user through an interactive list of questions needed to deploy sif core.

USAGE
  $ sif instance install -e <value> -t <value> [-r <value>] [-l <value>] [-h -c <value>]

FLAGS
  -c, --config=<value>       Path to configuration file used for deployment
  -e, --environment=<value>  (required) The environment to deploy the tenant to
  -h, --headless             If provided, bypass the questions. You will also need to specify the path configuration
                             file using -c
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The id of the tenant to deploy

DESCRIPTION
  Walks the user through an interactive list of questions needed to deploy sif core.

EXAMPLES
  $ sif instance install -t demo -e prod -r us-west-2

See code: src/commands/instance/install.ts

`sif instance list`

Lists all deployed tenants within a specific environment

USAGE
  $ sif instance list -e <value> [-r <value>]

FLAGS
  -e, --environment=<value>  (required) An environment represents an isolated deployment of tenantId(s)
  -r, --region=<value>       Region used for listing of sif tenants

DESCRIPTION
  Lists all deployed tenants within a specific environment

EXAMPLES
  $ sif instance list -t demo -e prod -r us-west-2 -a 1234567

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

`sif instance postman`

Walks the user through the process to generate the postman environment file.

USAGE
  $ sif instance postman -e <value> -t <value> [-r <value>] [-l <value>]

FLAGS
  -e, --environment=<value>  (required) The environment used to generate the postman environment file
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The tenantId used to generate the postman environment file

DESCRIPTION
  Walks the user through the process to generate the postman environment file.

EXAMPLES
  $ sif instance postman -t demo -e prod -r us-west-2 -a 1234567

See code: src/commands/instance/postman.ts

`sif instance start`

Run the selected SIF module locally

USAGE
  $ sif instance start -e <value> -t <value> -m <value> [-r <value>] [-l <value>]

FLAGS
  -e, --environment=<value>  (required) SIF environment to use for starting the module
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -m, --module=<value>       (required) SIF module to run
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) SIF tenantId to use for starting the module

DESCRIPTION
  Run the selected SIF module locally

EXAMPLES
  $ sif instance start -m pipelines

See code: src/commands/instance/start.ts

`sif instance upgrade`

Perform upgrade of SIF instance version

USAGE
  $ sif instance upgrade -e <value> -t <value> [-r <value>] [-l <value>] [-h -c <value>]

FLAGS
  -c, --config=<value>       Path to configuration file used for upgrade
  -e, --environment=<value>  (required) The environment to upgrade the tenant for
  -h, --headless             If provided, bypass the questions. You will also need to specify the path configuration
                             file using -c
  -l, --role=<value>         The RoleArn for the CLI to assume for deployment
  -r, --region=<value>       AWS region used when running the subcommands
  -t, --tenantId=<value>     (required) The id of the tenant to upgrade

DESCRIPTION
  Perform upgrade of SIF instance version

EXAMPLES
  $ sif instance upgrade -t demo -e prod -r us-west-2 -a 1234567

See code: src/commands/instance/upgrade.ts

`sif plugins`

List installed plugins.

USAGE
  $ sif plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ sif plugins

See code: @oclif/plugin-plugins

`sif plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ sif plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ sif plugins add

EXAMPLES
  $ sif plugins add myplugin 

  $ sif plugins add https://github.com/someuser/someplugin

  $ sif plugins add someuser/someplugin

`sif plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ sif plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ sif plugins inspect myplugin

See code: @oclif/plugin-plugins

`sif plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ sif plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ sif plugins add

EXAMPLES
  $ sif plugins install myplugin 

  $ sif plugins install https://github.com/someuser/someplugin

  $ sif plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`sif plugins:link PLUGIN`

Links a plugin into the CLI for development.

USAGE
  $ sif plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help      Show CLI help.
  -v, --verbose
  --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ sif plugins link myplugin

See code: @oclif/plugin-plugins

`sif plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ sif plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sif plugins unlink
  $ sif plugins remove

EXAMPLES
  $ sif plugins remove myplugin

`sif plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ sif plugins reset

See code: @oclif/plugin-plugins

`sif plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ sif plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sif plugins unlink
  $ sif plugins remove

EXAMPLES
  $ sif plugins uninstall myplugin

See code: @oclif/plugin-plugins

`sif plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ sif plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sif plugins unlink
  $ sif plugins remove

EXAMPLES
  $ sif plugins unlink myplugin

`sif plugins update`

Update installed plugins.

USAGE
  $ sif plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

Name		Name	Last commit message	Last commit date
Latest commit History 9 Commits
.github		.github
.gitlab		.gitlab
.vscode		.vscode
assets		assets
bin		bin
deployment		deployment
source		source
src		src
.editorconfig		.editorconfig
.env		.env
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
.mocharc.json		.mocharc.json
.prettierignore		.prettierignore
.prettierrc.yaml		.prettierrc.yaml
.semgrepignore		.semgrepignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
LICENSE.txt		LICENSE.txt
README.md		README.md
license.header.txt		license.header.txt
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

Licenses found

aws-solutions-library-samples/guidance-for-aws-sustainability-insights-framework-cli

Folders and files

Latest commit

History

Repository files navigation

sif-cli

Usage

Commands

sif core build

sif core clone

sif core releases

sif core switch

sif core version

sif environment configure

sif environment delete

sif environment install

sif environment list

sif environment upgrade

sif environment version

sif help [COMMANDS]

sif init

sif instance auth

sif instance configure

sif instance delete

sif instance insomnia

sif instance install

sif instance list

sif instance postman

sif instance start

sif instance upgrade

sif plugins

sif plugins:install PLUGIN...

sif plugins:inspect PLUGIN...

sif plugins:install PLUGIN...

sif plugins:link PLUGIN

sif plugins:uninstall PLUGIN...

sif plugins reset

sif plugins:uninstall PLUGIN...

sif plugins:uninstall PLUGIN...

sif plugins update

About

Resources

License

Licenses found

Code of conduct

Security policy

Stars

Watchers

Forks

Releases 2

Packages 0

Contributors 3

Languages

`sif core build`

`sif core clone`

`sif core releases`

`sif core switch`

`sif core version`

`sif environment configure`

`sif environment delete`

`sif environment install`

`sif environment list`

`sif environment upgrade`

`sif environment version`

`sif help [COMMANDS]`

`sif init`

`sif instance auth`

`sif instance configure`

`sif instance delete`

`sif instance insomnia`

`sif instance install`

`sif instance list`

`sif instance postman`

`sif instance start`

`sif instance upgrade`

`sif plugins`

`sif plugins:install PLUGIN...`

`sif plugins:inspect PLUGIN...`

`sif plugins:install PLUGIN...`

`sif plugins:link PLUGIN`

`sif plugins:uninstall PLUGIN...`

`sif plugins reset`

`sif plugins:uninstall PLUGIN...`

`sif plugins:uninstall PLUGIN...`

`sif plugins update`

Packages