Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@fathym/cli

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@fathym/cli

The CLI used for code first flows with Fathym EaC.

0.0.43
Source
npm

Version published: 2 years ago

Maintainers: 5

Created: 2 years ago

Source

oclif-hello-world

oclif example Hello World CLI

Usage

$ npm install -g @fathym/cli
$ fathym COMMAND
running command...
$ fathym (--version)
@fathym/cli/0.0.43 win32-x64 node-v18.12.1
$ fathym --help [COMMAND]
USAGE
  $ fathym COMMAND
...

Commands

`fathym auth`

Used to start the authentication process with Fathym, so your CLI can work with the EaC and other features.

USAGE
  $ fathym auth [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to start the authentication process with Fathym, so your CLI can work with the EaC and other features.

EXAMPLES
  $ fathym auth

See code: dist/commands/auth/index.ts

`fathym auth config`

Used to retrieve the current auth config for the user.

USAGE
  $ fathym auth config [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to retrieve the current auth config for the user.

EXAMPLES
  $ fathym auth config

`fathym auth out`

Used to sign out, so your CLI will NOT work with the EaC and other features.

USAGE
  $ fathym auth out [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to sign out, so your CLI will NOT work with the EaC and other features.

EXAMPLES
  $ fathym auth out

`fathym dev lcu scaffold [NAME]`

Used to scaffold a new LCU.

USAGE
  $ fathym dev lcu scaffold [NAME] [--ci] [-d <value>]

FLAGS
  -d, --directory=<value>  The directory to initialize and scaffold.
  --ci                     Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to scaffold a new LCU.

EXAMPLES
  $ fathym dev lcu scaffold dev lcu scaffold --help

`fathym dev set-api-root ENV`

Used to set the api root.

USAGE
  $ fathym dev set-api-root [ENV] [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to set the api root.

EXAMPLES
  $ fathym dev set-api-root

`fathym eac applications create`

Used for creating a new application.

USAGE
  $ fathym eac applications create [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a new application.

EXAMPLES
  $ fathym eac applications create

`fathym eac applications lcu`

Used for creating a managing application LCU settings.

USAGE
  $ fathym eac applications lcu [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a managing application LCU settings.

EXAMPLES
  $ fathym eac applications lcu

`fathym eac applications modifiers add`

Used for adding a DFS modifier to a application.

USAGE
  $ fathym eac applications modifiers add [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for adding a DFS modifier to a application.

EXAMPLES
  $ fathym eac applications modifiers add

`fathym eac applications processor`

Used for creating a managing application Processor settings.

USAGE
  $ fathym eac applications processor [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a managing application Processor settings.

EXAMPLES
  $ fathym eac applications processor

`fathym eac applications set APPLOOKUP`

Used for setting an active application lookup for use in other commands.

USAGE
  $ fathym eac applications set [APPLOOKUP] [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for setting an active application lookup for use in other commands.

EXAMPLES
  $ fathym eac applications set

`fathym eac changes`

Used to retrieve the current changes to EaC that are queued for commit.

USAGE
  $ fathym eac changes [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to retrieve the current changes to EaC that are queued for commit.

EXAMPLES
  $ fathym eac changes

`fathym eac commit MESSAGE`

Used for commiting changes to the EaC.

USAGE
  $ fathym eac commit [MESSAGE] [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for commiting changes to the EaC.

EXAMPLES
  $ fathym eac commit

`fathym eac export`

Used for exporting the EaC.

USAGE
  $ fathym eac export [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for exporting the EaC.

EXAMPLES
  $ fathym eac export

`fathym eac modifiers create`

Used for creating a new DFS modifier.

USAGE
  $ fathym eac modifiers create [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a new DFS modifier.

EXAMPLES
  $ fathym eac modifiers create

`fathym eac pipelines create`

Used for creating a new build pipeline.

USAGE
  $ fathym eac pipelines create [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a new build pipeline.

EXAMPLES
  $ fathym eac pipelines create

`fathym eac projects applications add`

Used for adding an application to a project.

USAGE
  $ fathym eac projects applications add [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for adding an application to a project.

EXAMPLES
  $ fathym eac projects applications add

`fathym eac projects applications preview`

Used for getting a preview link to a project application.

USAGE
  $ fathym eac projects applications preview [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for getting a preview link to a project application.

EXAMPLES
  $ fathym eac projects applications preview

`fathym eac projects create`

Used for creating a new project.

USAGE
  $ fathym eac projects create [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a new project.

EXAMPLES
  $ fathym eac projects create

`fathym eac projects list`

Used for creating a new project.

USAGE
  $ fathym eac projects list [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a new project.

EXAMPLES
  $ fathym eac projects list

`fathym eac projects modifiers add`

Used for adding a DFS modifier to a project.

USAGE
  $ fathym eac projects modifiers add [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for adding a DFS modifier to a project.

EXAMPLES
  $ fathym eac projects modifiers add

`fathym eac projects set APPLOOKUP`

Used for setting an active project lookup for use in other commands.

USAGE
  $ fathym eac projects set [APPLOOKUP] [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for setting an active project lookup for use in other commands.

EXAMPLES
  $ fathym eac projects set

`fathym eac sources create`

Used for creating a new source control.

USAGE
  $ fathym eac sources create [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a new source control.

EXAMPLES
  $ fathym eac sources create

`fathym eac sources pipeline attach`

Used for attaching a build pipeline to a source control.

USAGE
  $ fathym eac sources pipeline attach [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for attaching a build pipeline to a source control.

EXAMPLES
  $ fathym eac sources pipeline attach

`fathym enterprises get`

Get's the current user's active enterprise for the CLI. Determines

USAGE
  $ fathym enterprises get [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Get's the current user's active enterprise for the CLI. Determines
  which enterprise commands are executed against.

EXAMPLES
  $ fathym enterprises get

`fathym enterprises list`

Used to list the current users available enterprises.

USAGE
  $ fathym enterprises list [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used to list the current users available enterprises.

EXAMPLES
  $ fathym enterprises list

`fathym enterprises set ENTLOOKUP`

Set's the current user's active enterprise for the CLI. Determines

USAGE
  $ fathym enterprises set [ENTLOOKUP] [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Set's the current user's active enterprise for the CLI. Determines
  which enterprise commands are executed against.

EXAMPLES
  $ fathym enterprises set

`fathym git [MESSAGE]`

Used for committing changes to the current working branch and syncing with integration.

USAGE
  $ fathym git [MESSAGE] [--ci] [-r]

FLAGS
  -r, --rebase  When specified does a rebase instead of a merge.
  --ci          Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for committing changes to the current working branch and syncing with integration.

EXAMPLES
  $ fathym git "Commit messag here"

See code: dist/commands/git/index.ts

`fathym git auth`

Used for authenticating the user with Git.

USAGE
  $ fathym git auth [--ci] [-f]

FLAGS
  -f, --force  Force authentication process to present git rights, even if the user is already authenticated.
  --ci         Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for authenticating the user with Git.

EXAMPLES
  $ fathym git auth

`fathym git clone [ORGANIZATION] REPOSITORY`

Used for cloning the source control for Git.

USAGE
  $ fathym git clone [ORGANIZATION] [REPOSITORY] [--ci] [-d <value>] [-b <value>]

FLAGS
  -b, --branch=<value>  Specifies the branch or tag to clone
  -d, --depth=<value>   Specifies the depth of the clone
  --ci                  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for cloning the source control for Git.

EXAMPLES
  $ fathym git clone

`fathym git feature NAME`

Used for creating a feature branch from 'integration' in git.

USAGE
  $ fathym git feature [NAME] [--ci]

ARGUMENTS
  NAME  Name for the new feature branch

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a feature branch from 'integration' in git.

EXAMPLES
  $ fathym git feature

`fathym git hotfix NAME`

Used for creating a hotfix branch from 'main' in git.

USAGE
  $ fathym git hotfix [NAME] [--ci]

ARGUMENTS
  NAME  Name for the new hotfix branch

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for creating a hotfix branch from 'main' in git.

EXAMPLES
  $ fathym git hotfix

`fathym git import [ORGANIZATION] REPOSITORY REMOTE`

Used for importing a remote source control into a configured EaC Source control.

USAGE
  $ fathym git import [ORGANIZATION] [REPOSITORY] [REMOTE] [--ci] [-d <value>] [-b <value>]

FLAGS
  -b, --branch=<value>  Specifies the branch or tag to clone
  -d, --depth=<value>   Specifies the depth of the clone
  --ci                  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for importing a remote source control into a configured EaC Source control.

EXAMPLES
  $ fathym git import import organization repository "https://github.com/fathym-it/smart-building-demo

`fathym git repos [ORGANIZATION] [REPOSITORY] [BRANCH]`

Used for retrieving information about repositories including organizations, their repos and related branch information.

USAGE
  $ fathym git repos [ORGANIZATION] [REPOSITORY] [BRANCH] [--ci]

FLAGS
  --ci  Run command in yield mode for automation, to prevent prompts.

DESCRIPTION
  Used for retrieving information about repositories including organizations, their repos and related branch
  information.

EXAMPLES
  $ fathym git repos {organization} {repository} {branc}

`fathym help [COMMAND]`

Display help for fathym.

USAGE
  $ fathym 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 fathym.

See code: @oclif/plugin-help

`fathym lcu LCU`

Used to install, or walk a user through installing an LCU.

USAGE
  $ fathym lcu [LCU] [--ci] [-o <value>] [--parameters <value>] [-p <value>]

FLAGS
  -o, --organization=<value>  The organization to deploy LCU code repositories to.
  -p, --project=<value>       The project to deploy the LCU into.
  --ci                        Run command in yield mode for automation, to prevent prompts.
  --parameters=<value>        Specify values to use in the parameters list: ({ paramName: paramValue })

DESCRIPTION
  Used to install, or walk a user through installing an LCU.

EXAMPLES
  $ fathym lcu

See code: dist/commands/lcu/index.ts

`fathym plugins`

List installed plugins.

USAGE
  $ fathym plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ fathym plugins

See code: @oclif/plugin-plugins

`fathym plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ fathym plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

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

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
  $ fathym plugins add

EXAMPLES
  $ fathym plugins:install myplugin 

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

  $ fathym plugins:install someuser/someplugin

`fathym plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ fathym plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ fathym plugins:inspect myplugin

`fathym plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ fathym plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

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

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
  $ fathym plugins add

EXAMPLES
  $ fathym plugins:install myplugin 

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

  $ fathym plugins:install someuser/someplugin

`fathym plugins:link PLUGIN`

Links a plugin into the CLI for development.

USAGE
  $ fathym plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

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

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
  $ fathym plugins:link myplugin

`fathym plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ fathym plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fathym plugins unlink
  $ fathym plugins remove

`fathym plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ fathym plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fathym plugins unlink
  $ fathym plugins remove

`fathym plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ fathym plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fathym plugins unlink
  $ fathym plugins remove

`fathym plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

Keywords

oclif

FAQs

What is @fathym/cli?

Is @fathym/cli well maintained?

Package last updated on 26 Jan 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@fathym/cli

oclif-hello-world

Usage

Commands

fathym auth

fathym auth config

fathym auth out

fathym dev lcu scaffold [NAME]

fathym dev set-api-root ENV

fathym eac applications create

fathym eac applications lcu

fathym eac applications modifiers add

fathym eac applications processor

fathym eac applications set APPLOOKUP

fathym eac changes

fathym eac commit MESSAGE

fathym eac export

fathym eac modifiers create

fathym eac pipelines create

fathym eac projects applications add

fathym eac projects applications preview

fathym eac projects create

fathym eac projects list

fathym eac projects modifiers add

fathym eac projects set APPLOOKUP

fathym eac sources create

fathym eac sources pipeline attach

fathym enterprises get

fathym enterprises list

fathym enterprises set ENTLOOKUP

fathym git [MESSAGE]

fathym git auth

fathym git clone [ORGANIZATION] REPOSITORY

fathym git feature NAME

fathym git hotfix NAME

fathym git import [ORGANIZATION] REPOSITORY REMOTE

fathym git repos [ORGANIZATION] [REPOSITORY] [BRANCH]

fathym help [COMMAND]

fathym lcu LCU

fathym plugins

fathym plugins:install PLUGIN...

fathym plugins:inspect PLUGIN...

fathym plugins:install PLUGIN...

fathym plugins:link PLUGIN

fathym plugins:uninstall PLUGIN...

fathym plugins:uninstall PLUGIN...

fathym plugins:uninstall PLUGIN...

fathym plugins update

Keywords

Related posts

Malicious PyPI Package ‘pycord-self’ Targets Discord Developers with Token Theft and Backdoor Exploit

UK Officials Consider Banning Ransomware Payments from Public Entities

`fathym auth`

`fathym auth config`

`fathym auth out`

`fathym dev lcu scaffold [NAME]`

`fathym dev set-api-root ENV`

`fathym eac applications create`

`fathym eac applications lcu`

`fathym eac applications modifiers add`

`fathym eac applications processor`

`fathym eac applications set APPLOOKUP`

`fathym eac changes`

`fathym eac commit MESSAGE`

`fathym eac export`

`fathym eac modifiers create`

`fathym eac pipelines create`

`fathym eac projects applications add`

`fathym eac projects applications preview`

`fathym eac projects create`

`fathym eac projects list`

`fathym eac projects modifiers add`

`fathym eac projects set APPLOOKUP`

`fathym eac sources create`

`fathym eac sources pipeline attach`

`fathym enterprises get`

`fathym enterprises list`

`fathym enterprises set ENTLOOKUP`

`fathym git [MESSAGE]`

`fathym git auth`

`fathym git clone [ORGANIZATION] REPOSITORY`

`fathym git feature NAME`

`fathym git hotfix NAME`

`fathym git import [ORGANIZATION] REPOSITORY REMOTE`

`fathym git repos [ORGANIZATION] [REPOSITORY] [BRANCH]`

`fathym help [COMMAND]`

`fathym lcu LCU`

`fathym plugins`

`fathym plugins:install PLUGIN...`

`fathym plugins:inspect PLUGIN...`

`fathym plugins:install PLUGIN...`

`fathym plugins:link PLUGIN`

`fathym plugins:uninstall PLUGIN...`

`fathym plugins:uninstall PLUGIN...`

`fathym plugins:uninstall PLUGIN...`

`fathym plugins update`