Run Commands

Your First Command

Once you have configured your context (with any of the supported authentication methods), you can now run commands. There is no need to explicitly login, although you can do so if you like (use the fsoc login command); commands will transparently log in and/or refresh the access token when needed.

For example:

fsoc help solution list

Sample output:

This command list all the solutions that are deployed in the current tenant specified in the profile.

Usage:
        fsoc solution list

Usage:
  fsoc solution list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string    config file (default is $HOME/.fsoc)
      --fields string    perform specified fields transform/extract JQ expression
  -o, --output string    output format (auto, table, detail, json, yaml) (default "auto")
      --profile string   access profile (default is current or "default")
  -v, --verbose          Enable detailed output

Another sample command:

fsoc solution list

Sample output:

               NAME                 TAG    ISSYSTEM  ISSUBSCRIBED                             DEPENDENCIES

  extensibility                    stable  true      true          []
  environment                      stable  true      true          ["extensibility"]
  fmm                              stable  true      true          []
  common                           stable  true      true          ["fmm"]
  healthrule                       stable  true      true          ["fmm","dashui"]
  infra                            stable  false     true          ["fmm","common","healthrule","dashui"]
  onprem                           stable  false     true          ["fmm","common","healthrule","infra","dashui"]
  cloud                            stable  false     true          ["fmm","common","healthrule","dashui","infra","messaging"]
  aws                              stable  false     true          ["fmm","common","healthrule","dashui","infra","cloud"]
  azure                            stable  false     false         ["fmm","common","healthrule","dashui","infra","cloud","messaging"]
  kafka                            stable  false     true          ["fmm","healthrule","common","dashui"]
  redis                            stable  false     true          ["fmm","healthrule","common","dashui"]
  apm                              stable  false     true          ["fmm","dashui","healthrule","common"]
  logs                             stable  true      true          ["fmm","common","iam"]
  otelcol                          stable  false     false         ["common","apm","k8s"]
  k8s                              stable  false     true          ["fmm","common","infra","healthrule","dashui"]
...

Note: If you use the OAuth authentication method, the first time you run a command, fsoc will open a browser window and guide you through the login. Once the login completes successfully, you can close the browser window and return to the command line.

A UQL Query

Most people will need to run a UQL query. The following command shows how to do this (hint: omit the | head to get the full output):

fsoc uql --raw "FETCH id, type, attributes FROM entities(k8s:workload)" | head

Sample output:

[{
  "type" : "model",
  "model" : {
    "name" : "m:main",
    "fields" : [ {
      "alias" : "id",
      "type" : "string",
      "hints" : {
        "kind" : "entity",
        "field" : "id",

Output Options

By default, fsoc displays output data in human-readable form (such as tables). To format the output in machine-readable formats, such as JSON and YAML, use the --output option. To transform and extract fields for automated tasks, use the --fields option.

Built-in Help

To see all commands and flags, run fsoc help or fsoc help <command>.