Requirements

cloudfairy kubernetes controller installed on cluster, and active kubeconfig context.

Installtion of cloudfairy controller: see https://github.com/cloud-fairy/kubernetes or using the cli command fairy install-controller

kubectl apply -f https://raw.githubusercontent.com/cloud-fairy/kubernetes/refs/heads/main/install-cloudfairy.yaml

Usage

$ npm install -g @cloudfairy/cli
$ fairy COMMAND
running command...
$ fairy (--version)
@cloudfairy/cli/0.2.2 darwin-arm64 node-v20.17.0
$ fairy --help [COMMAND]
USAGE
  $ fairy COMMAND
...

Commands

• fairy create-project
• fairy delete-project [FILE]
• fairy designer
• fairy environment
• fairy environment create NAME
• fairy environment delete NAME
• fairy environment deploy NAME
• fairy environment list
• fairy help [COMMAND]
• fairy info [FILE]
• fairy inspect KIND NAME
• fairy install-controller

fairy create-project

Creates a new project

USAGE
  $ fairy create-project -p <value> [--copyFrom <value>] [--namespace <value>]

FLAGS
  -p, --project=<value>    (required) project name
      --copyFrom=<value>   copy from existing project
      --namespace=<value>  [default: default] namespace

DESCRIPTION
  Creates a new project

EXAMPLES
  $ fairy create-project

fairy delete-project [FILE]

Delete a project

USAGE
  $ fairy delete-project [FILE] -p <value> [--namespace <value>]

ARGUMENTS
  FILE  file to read

FLAGS
  -p, --project=<value>    (required) project name to delete
      --namespace=<value>  [default: default] namespace

DESCRIPTION
  Delete a project

EXAMPLES
  $ fairy delete-project my-project

fairy designer

Start cloudfairy visual designer

USAGE
  $ fairy designer

DESCRIPTION
  Start cloudfairy visual designer

EXAMPLES
  $ fairy designer

fairy environment

Manage Environments

USAGE
  $ fairy environment

DESCRIPTION
  Manage Environments

ALIASES
  $ fairy env

fairy environment create NAME

Manage Environments

USAGE
  $ fairy environment create NAME -p <value>

ARGUMENTS
  NAME  environment name

FLAGS
  -p, --project=<value>  (required) project name

DESCRIPTION
  Manage Environments

ALIASES
  $ fairy env create
  $ fairy env new

EXAMPLES
  $ fairy environment create staging

fairy environment delete NAME

Manage Environments

USAGE
  $ fairy environment delete NAME -p <value>

ARGUMENTS
  NAME  environment name

FLAGS
  -p, --project=<value>  (required) project name

DESCRIPTION
  Manage Environments

ALIASES
  $ fairy env delete

EXAMPLES
  $ fairy environment delete deploy -p my-project env-name

fairy environment deploy NAME

Manage Environments

USAGE
  $ fairy environment deploy NAME -p <value>

ARGUMENTS
  NAME  environment name

FLAGS
  -p, --project=<value>  (required) project name

DESCRIPTION
  Manage Environments

ALIASES
  $ fairy env deploy

EXAMPLES
  $ fairy environment deploy deploy -p my-project env-name

fairy environment list

Manage Environments

USAGE
  $ fairy environment list -p <value>

FLAGS
  -p, --project=<value>  (required) project name

DESCRIPTION
  Manage Environments

ALIASES
  $ fairy env list
  $ fairy env ls

EXAMPLES
  $ fairy environment list list -p my-project

fairy help [COMMAND]

Display help for fairy.

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

See code: @oclif/plugin-help

fairy info [FILE]

Get cloudfairy installation information

USAGE
  $ fairy info [FILE] [-f] [-n <value>]

ARGUMENTS
  FILE  file to read

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  Get cloudfairy installation information

EXAMPLES
  $ fairy info

fairy inspect KIND NAME

Describe a cloudfairy entity

USAGE
  $ fairy inspect KIND NAME

ARGUMENTS
  KIND  kind of entity to inspect (project, module, connector)
  NAME  entity name

DESCRIPTION
  Describe a cloudfairy entity

ALIASES
  $ fairy i
  $ fairy describe
  $ fairy d

EXAMPLES
  $ fairy describe project my-project

  $ fairy describe module my-org/my-module

  $ fairy describe connector my-org/my-connector

fairy install-controller

Install cloudfairy controller on kubenrnetes cluster

USAGE
  $ fairy install-controller [--context <value>] [-y]

FLAGS
  -y, --yes              skip confirmation
      --context=<value>  selected kubernetes context

DESCRIPTION
  Install cloudfairy controller on kubenrnetes cluster

EXAMPLES
  $ fairy install-controller --context my-kube-context

  $ fairy install-controller --ctx my-kube-context

Table of contents