@adobe-csc/fusion-admin
v0.0.16
Published
Command line utility to execute Fusion Admin tasks
Readme
fusion-admin-cli
Command line utility to execute Fusion Admin tasks
Demo Video
https://git.corp.adobe.com/storage/user/1126/files/d801927b-6a7f-43a1-a838-77927ba82e61
Table of contents
Usage
$ npm install -g @adobe-csc/fusion-admin
$ fusion-admin COMMAND
running command...
$ fusion-admin (--version)
@adobe-csc/fusion-admin/0.0.16 darwin-arm64 node-v20.14.0
$ fusion-admin --help [COMMAND]
USAGE
$ fusion-admin COMMAND
...Commands
fusion-admin aboutfusion-admin config ACTIONfusion-admin export ACTIONfusion-admin help [COMMAND]fusion-admin import [ACTION]fusion-admin list ACTIONfusion-admin orgs ACTIONfusion-admin pluginsfusion-admin plugins add PLUGINfusion-admin plugins:inspect PLUGIN...fusion-admin plugins install PLUGINfusion-admin plugins link PATHfusion-admin plugins remove [PLUGIN]fusion-admin plugins resetfusion-admin plugins uninstall [PLUGIN]fusion-admin plugins unlink [PLUGIN]fusion-admin plugins updatefusion-admin scenarios [ACTION]fusion-admin select [ACTION]fusion-admin teams [ACTION]
fusion-admin about
About this Fusion CLI
USAGE
$ fusion-admin about
DESCRIPTION
About this Fusion CLIfusion-admin config ACTION
Fusion config actions: init, show
USAGE
$ fusion-admin config ACTION
ARGUMENTS
ACTION Actions on Fusion CLI configuration
DESCRIPTION
Fusion config actions: init, show
EXAMPLES
$ fusion-admin config showfusion-admin export ACTION
Export Fusion resources
USAGE
$ fusion-admin export ACTION [-o <value>] [-t <value>] [-c] [-n <value>] [-w] [-s]
ARGUMENTS
ACTION Export actions [scenarios, webhooks, datastructures, datastores]
FLAGS
-c, --folderId Folder ID
-n, --destination=<value> Output directory
-o, --orgId=<value> Organization ID
-s, --datastore Include Datastores
-t, --teamId=<value> Team ID
-w, --webhooks Include Webhooks
DESCRIPTION
Export Fusion resources
EXAMPLES
$ fusion-admin exportfusion-admin help [COMMAND]
Display help for fusion-admin.
USAGE
$ fusion-admin help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for fusion-admin.See code: @oclif/plugin-help
fusion-admin import [ACTION]
Import Fusion resources
USAGE
$ fusion-admin import [ACTION] -i <value> [-w] [-s] [-f] [-o <value>] [-t <value>] [-c <value>] [-d]
ARGUMENTS
ACTION Import actions [scenarios, hooks]
FLAGS
-c, --folderId=<value> Folder ID
-d, --debug Enable debug logging
-f, --forceUpdate Force asset updates
-i, --input=<value> (required) Input assets (glob pattern supported)
-o, --orgId=<value> Organization ID
-s, --datastructures Auto-create data structures
-t, --teamId=<value> Team ID
-w, --webhooks Auto-create webhooks
DESCRIPTION
Import Fusion resources
EXAMPLES
$ fusion-admin importfusion-admin list ACTION
List Fusion resources
USAGE
$ fusion-admin list ACTION [-t <value>] [-f <value>]
ARGUMENTS
ACTION Action to take on the organization [orgs, teams, folders,scenarios, hooks ]
FLAGS
-f, --folderId=<value> Folder Id is used for scenarios
-t, --teamId=<value> Team Id id used for folders, scenarios and hooks
DESCRIPTION
List Fusion resources
EXAMPLES
$ fusion-admin listfusion-admin orgs ACTION
Fusion org actions. --help for more information.
USAGE
$ fusion-admin orgs ACTION
ARGUMENTS
ACTION Action to take on the organization [list, select]
DESCRIPTION
Fusion org actions. --help for more information.
EXAMPLES
$ fusion-admin orgs listfusion-admin plugins
List installed plugins.
USAGE
$ fusion-admin plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ fusion-admin pluginsSee code: @oclif/plugin-plugins
fusion-admin plugins add PLUGIN
Installs a plugin into fusion-admin.
USAGE
$ fusion-admin plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into fusion-admin.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the FUSION_ADMIN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the FUSION_ADMIN_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ fusion-admin plugins add
EXAMPLES
Install a plugin from npm registry.
$ fusion-admin plugins add myplugin
Install a plugin from a github url.
$ fusion-admin plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ fusion-admin plugins add someuser/somepluginfusion-admin plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ fusion-admin 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
$ fusion-admin plugins inspect mypluginSee code: @oclif/plugin-plugins
fusion-admin plugins install PLUGIN
Installs a plugin into fusion-admin.
USAGE
$ fusion-admin plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into fusion-admin.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the FUSION_ADMIN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the FUSION_ADMIN_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ fusion-admin plugins add
EXAMPLES
Install a plugin from npm registry.
$ fusion-admin plugins install myplugin
Install a plugin from a github url.
$ fusion-admin plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ fusion-admin plugins install someuser/somepluginSee code: @oclif/plugin-plugins
fusion-admin plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ fusion-admin plugins link PATH [-h] [--install] [-v]
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
$ fusion-admin plugins link mypluginSee code: @oclif/plugin-plugins
fusion-admin plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ fusion-admin plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fusion-admin plugins unlink
$ fusion-admin plugins remove
EXAMPLES
$ fusion-admin plugins remove mypluginfusion-admin plugins reset
Remove all user-installed and linked plugins.
USAGE
$ fusion-admin plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
fusion-admin plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ fusion-admin plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fusion-admin plugins unlink
$ fusion-admin plugins remove
EXAMPLES
$ fusion-admin plugins uninstall mypluginSee code: @oclif/plugin-plugins
fusion-admin plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ fusion-admin plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fusion-admin plugins unlink
$ fusion-admin plugins remove
EXAMPLES
$ fusion-admin plugins unlink mypluginfusion-admin plugins update
Update installed plugins.
USAGE
$ fusion-admin plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
fusion-admin scenarios [ACTION]
Fusion team actions. --help for more information.
USAGE
$ fusion-admin scenarios [ACTION] [-o <value>] [-t <value>] [-f <value>] [-d <value>] [-s <value>] [-h]
ARGUMENTS
ACTION Actions for Fusion scenarios: list, export
FLAGS
-d, --destination=<value> Destination folder
-f, --folderId=<value> Folder
-h, --includeHooks Include hooks
-o, --orgId=<value> Organization
-s, --source=<value> source folder
-t, --teamId=<value> Team
DESCRIPTION
Fusion team actions. --help for more information.
EXAMPLES
$ fusion-admin scenarios export -d /path/to/folderfusion-admin select [ACTION]
Select default Fusion configurations
USAGE
$ fusion-admin select [ACTION]
ARGUMENTS
ACTION Select defaults - [org, team]
DESCRIPTION
Select default Fusion configurations
EXAMPLES
$ fusion-admin selectfusion-admin teams [ACTION]
Fusion team actions. --help for more information.
USAGE
$ fusion-admin teams [ACTION] [-o <value>]
ARGUMENTS
ACTION Actions for Fusion Teams
FLAGS
-o, --orgId=<value>
DESCRIPTION
Fusion team actions. --help for more information.
EXAMPLES
$ fusion-admin teams listDevelopment
Getting started
- Linking local modules: https://medium.com/@AidThompsin/how-to-npm-link-to-a-local-version-of-your-dependency-84e82126667a
Local Testing
In order to test locally, you may choose to setup a .env file like so:
FUSION_URL=https://app.workfrontfusion.com/api/v2
FUSION_TOKEN=<token>
FUSION_ORG_ID=<org-id>
FUSION_TEAM_ID=<team-id>