From c2f5c848c366146b13d83b73d481c05261678489 Mon Sep 17 00:00:00 2001 From: Grant Arnold Date: Thu, 9 Feb 2023 16:01:42 -0800 Subject: [PATCH 1/4] Add doc generation and docs. --- README.md | 14 ++-- cmd/root.go | 2 +- docgen/README.md | 14 ++++ docgen/docgen.go | 15 +++++ docs/fmeserver.md | 35 ++++++++++ docs/fmeserver_backup.md | 47 +++++++++++++ docs/fmeserver_cancel.md | 40 +++++++++++ docs/fmeserver_deploymentparameters.md | 51 ++++++++++++++ docs/fmeserver_deploymentparameters_create.md | 42 ++++++++++++ docs/fmeserver_deploymentparameters_delete.md | 45 +++++++++++++ docs/fmeserver_deploymentparameters_update.md | 42 ++++++++++++ docs/fmeserver_engines.md | 50 ++++++++++++++ docs/fmeserver_healthcheck.md | 50 ++++++++++++++ docs/fmeserver_info.md | 47 +++++++++++++ docs/fmeserver_jobs.md | 67 +++++++++++++++++++ docs/fmeserver_license.md | 33 +++++++++ docs/fmeserver_license_machinekey.md | 30 +++++++++ docs/fmeserver_license_refresh.md | 40 +++++++++++ docs/fmeserver_license_refresh_status.md | 46 +++++++++++++ docs/fmeserver_license_request.md | 54 +++++++++++++++ docs/fmeserver_license_request_status.md | 46 +++++++++++++ docs/fmeserver_license_requestfile.md | 48 +++++++++++++ docs/fmeserver_license_status.md | 32 +++++++++ docs/fmeserver_license_systemcode.md | 30 +++++++++ docs/fmeserver_login.md | 47 +++++++++++++ docs/fmeserver_migration.md | 27 ++++++++ docs/fmeserver_migration_tasks.md | 58 ++++++++++++++++ docs/fmeserver_projects.md | 47 +++++++++++++ docs/fmeserver_projects_download.md | 44 ++++++++++++ docs/fmeserver_projects_upload.md | 46 +++++++++++++ docs/fmeserver_repositories.md | 58 ++++++++++++++++ docs/fmeserver_repositories_create.md | 45 +++++++++++++ docs/fmeserver_repositories_delete.md | 45 +++++++++++++ docs/fmeserver_restore.md | 56 ++++++++++++++++ docs/fmeserver_run.md | 65 ++++++++++++++++++ docs/fmeserver_workspaces.md | 56 ++++++++++++++++ go.mod | 2 + go.sum | 2 + 38 files changed, 1507 insertions(+), 11 deletions(-) create mode 100644 docgen/README.md create mode 100644 docgen/docgen.go create mode 100644 docs/fmeserver.md create mode 100644 docs/fmeserver_backup.md create mode 100644 docs/fmeserver_cancel.md create mode 100644 docs/fmeserver_deploymentparameters.md create mode 100644 docs/fmeserver_deploymentparameters_create.md create mode 100644 docs/fmeserver_deploymentparameters_delete.md create mode 100644 docs/fmeserver_deploymentparameters_update.md create mode 100644 docs/fmeserver_engines.md create mode 100644 docs/fmeserver_healthcheck.md create mode 100644 docs/fmeserver_info.md create mode 100644 docs/fmeserver_jobs.md create mode 100644 docs/fmeserver_license.md create mode 100644 docs/fmeserver_license_machinekey.md create mode 100644 docs/fmeserver_license_refresh.md create mode 100644 docs/fmeserver_license_refresh_status.md create mode 100644 docs/fmeserver_license_request.md create mode 100644 docs/fmeserver_license_request_status.md create mode 100644 docs/fmeserver_license_requestfile.md create mode 100644 docs/fmeserver_license_status.md create mode 100644 docs/fmeserver_license_systemcode.md create mode 100644 docs/fmeserver_login.md create mode 100644 docs/fmeserver_migration.md create mode 100644 docs/fmeserver_migration_tasks.md create mode 100644 docs/fmeserver_projects.md create mode 100644 docs/fmeserver_projects_download.md create mode 100644 docs/fmeserver_projects_upload.md create mode 100644 docs/fmeserver_repositories.md create mode 100644 docs/fmeserver_repositories_create.md create mode 100644 docs/fmeserver_repositories_delete.md create mode 100644 docs/fmeserver_restore.md create mode 100644 docs/fmeserver_run.md create mode 100644 docs/fmeserver_workspaces.md diff --git a/README.md b/README.md index 67dcba5..a0533c1 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,11 @@ fmeserver login https://my-fmeserver.com --token my-token-here fmeserver info ``` +For full documentation of all commands, see the [Documentation](doc/fmeserver.md). + + ## Development -* `cobra-cli` will be needed to add new commands -``` -go install github.com/spf13/cobra-cli@latest -``` * Run while coding: ``` go run main.go @@ -42,11 +41,6 @@ go run main.go ``` go build -o fmeserver ``` -* Add a new command -``` -cobra-cli add new-command -``` -More details [here](https://github.com/spf13/cobra-cli/blob/main/README.md) A great resource for adding new structs to represent JSON returned from FME Server is this [JSON to Go converter](https://mholt.github.io/json-to-go/) which will create a Go struct for you from a JSON sample. @@ -56,4 +50,4 @@ There is a github action that will run when a new release is created that will b ## Acknowledgments -* Created using [cobra](https://github.com/spf13/cobra) \ No newline at end of file +* Created using [cobra](https://github.com/spf13/cobra) diff --git a/cmd/root.go b/cmd/root.go index c433e06..b38cd99 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -30,7 +30,7 @@ func NewRootCommand() *cobra.Command { cmds := &cobra.Command{ Use: "fmeserver", Short: "A command line interface for interacting with FME Server.", - Long: `A command line interface for interacting with FME Server.`, + Long: `A command line interface for interacting with FME Server. See available commands below. Get started with the login command.`, Version: appVersion, SilenceErrors: true, SilenceUsage: true, diff --git a/docgen/README.md b/docgen/README.md new file mode 100644 index 0000000..93f97f3 --- /dev/null +++ b/docgen/README.md @@ -0,0 +1,14 @@ +# FME Server CLI Docgen + +This will generate docs based on the information for each command. + +## Generating the doc + +Run the command: +``` +go run docgen.go +``` + +to regenerate the documentation in the `docs` directory. + +Before committing changes, use a diff tool to ensure changes are correct and any manual edits that have been made post-generation are restored. diff --git a/docgen/docgen.go b/docgen/docgen.go new file mode 100644 index 0000000..d125f9e --- /dev/null +++ b/docgen/docgen.go @@ -0,0 +1,15 @@ +package main + +import ( + "log" + + "github.com/safesoftare/fmeserver-cli/cmd" + "github.com/spf13/cobra/doc" +) + +func main() { + err := doc.GenMarkdownTree(cmd.NewRootCommand(), "../docs") + if err != nil { + log.Fatal(err) + } +} diff --git a/docs/fmeserver.md b/docs/fmeserver.md new file mode 100644 index 0000000..571321a --- /dev/null +++ b/docs/fmeserver.md @@ -0,0 +1,35 @@ +## fmeserver + +A command line interface for interacting with FME Server. + +### Synopsis + +A command line interface for interacting with FME Server. See available commands below. Get started with the login command. + +### Options + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + -h, --help help for fmeserver + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver backup](fmeserver_backup.md) - Backs up the FME Server configuration +* [fmeserver cancel](fmeserver_cancel.md) - Cancel a running job on FME Server +* [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters +* [fmeserver engines](fmeserver_engines.md) - Get information about the FME Engines +* [fmeserver healthcheck](fmeserver_healthcheck.md) - Retrieves the health status of FME Server +* [fmeserver info](fmeserver_info.md) - Retrieves build, version and time information about FME Server +* [fmeserver jobs](fmeserver_jobs.md) - Lists jobs on FME Server +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server +* [fmeserver login](fmeserver_login.md) - Save credentials for an FME Server +* [fmeserver migration](fmeserver_migration.md) - Returns information on migration tasks using the tasks subcommand. +* [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server +* [fmeserver repositories](fmeserver_repositories.md) - List repositories +* [fmeserver restore](fmeserver_restore.md) - Restores the FME Server configuration from an import package +* [fmeserver run](fmeserver_run.md) - Run a workspace on FME Server +* [fmeserver workspaces](fmeserver_workspaces.md) - List workspaces by repository + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_backup.md b/docs/fmeserver_backup.md new file mode 100644 index 0000000..5ac08c9 --- /dev/null +++ b/docs/fmeserver_backup.md @@ -0,0 +1,47 @@ +## fmeserver backup + +Backs up the FME Server configuration + +### Synopsis + +Backs up the FME Server configuration to a local file or to a shared resource location on the FME Server. + +``` +fmeserver backup [flags] +``` + +### Examples + +``` + + # back up to a local file + fmeserver backup -f my_local_backup.fsconfig + + # back up to the "Backup" folder in the FME Server Shared Resources with the file name my_fme_backup.fsconfig + fmeserver backup --resource --export-package my_fme_backup.fsconfig +``` + +### Options + +``` + --export-package string Path and name of the export package. (default "ServerConfigPackage.fsconfig") + --failure-topic string Topic to notify on failure of the backup. Default is MIGRATION_ASYNC_JOB_FAILURE + -f, --file string Path to file to download the backup to. (default "ServerConfigPackage.fsconfig") + -h, --help help for backup + --resource Backup to a shared resource instead of downloading. + --resource-name string Shared Resource Name where the exported package is saved. (default "FME_SHAREDRESOURCE_BACKUP") + --success-topic string Topic to notify on success of the backup. Default is MIGRATION_ASYNC_JOB_SUCCESS +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_cancel.md b/docs/fmeserver_cancel.md new file mode 100644 index 0000000..2ec310f --- /dev/null +++ b/docs/fmeserver_cancel.md @@ -0,0 +1,40 @@ +## fmeserver cancel + +Cancel a running job on FME Server + +### Synopsis + +Cancels the job and marks it as aborted in the completed jobs section, but does not remove it from the database. + +``` +fmeserver cancel [flags] +``` + +### Examples + +``` + + # Cancel a job with id 42 + fmeserver cancel --id 42 + +``` + +### Options + +``` + -h, --help help for cancel + --id string The ID of the job to cancel. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters.md b/docs/fmeserver_deploymentparameters.md new file mode 100644 index 0000000..b69acaa --- /dev/null +++ b/docs/fmeserver_deploymentparameters.md @@ -0,0 +1,51 @@ +## fmeserver deploymentparameters + +List Deployment Parameters + +### Synopsis + +Lists Deployment Parameters on the given FME Server. + +``` +fmeserver deploymentparameters [flags] +``` + +### Examples + +``` + + Examples: + # List all deployment parameters + fmeserver deploymentparameters + + # List a single deployment parameter + fmeserver deploymentparameters --name testParameter + + # Output all deploymentparameters in json format + fmeserver deploymentparameters --json +``` + +### Options + +``` + -h, --help help for deploymentparameters + --name string If specified, only the repository with that name will be returned + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. +* [fmeserver deploymentparameters create](fmeserver_deploymentparameters_create.md) - Create a deployment parameter +* [fmeserver deploymentparameters delete](fmeserver_deploymentparameters_delete.md) - Delete a deployment parameter +* [fmeserver deploymentparameters update](fmeserver_deploymentparameters_update.md) - Update a deployment parameter + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters_create.md b/docs/fmeserver_deploymentparameters_create.md new file mode 100644 index 0000000..883eabc --- /dev/null +++ b/docs/fmeserver_deploymentparameters_create.md @@ -0,0 +1,42 @@ +## fmeserver deploymentparameters create + +Create a deployment parameter + +### Synopsis + +Create a deployment parameter. + +``` +fmeserver deploymentparameters create [flags] +``` + +### Examples + +``` + + Examples: + # Create a deployment parameter with the name "myParam" and the value "myValue" + fmeserver deploymentparameter create --name myParam --value myValue + +``` + +### Options + +``` + -h, --help help for create + --name string Name of the deployment parameter to create. + --value string The value to set the deployment parameter to. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters_delete.md b/docs/fmeserver_deploymentparameters_delete.md new file mode 100644 index 0000000..2275027 --- /dev/null +++ b/docs/fmeserver_deploymentparameters_delete.md @@ -0,0 +1,45 @@ +## fmeserver deploymentparameters delete + +Delete a deployment parameter + +### Synopsis + +Delete a deployment parameter. + +``` +fmeserver deploymentparameters delete [flags] +``` + +### Examples + +``` + + Examples: + # Delete adeployment parameter with the name "myParam" + fmeserver deploymentparameter delete --name myParam + + # Delete a repository with the name "myRepository" and no confirmation + fmeserver deploymentparameter delete --name myParam --no-prompt + +``` + +### Options + +``` + -h, --help help for delete + --name string Name of the repository to create. + -y, --no-prompt Description of the new repository. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters_update.md b/docs/fmeserver_deploymentparameters_update.md new file mode 100644 index 0000000..9bb0ebe --- /dev/null +++ b/docs/fmeserver_deploymentparameters_update.md @@ -0,0 +1,42 @@ +## fmeserver deploymentparameters update + +Update a deployment parameter + +### Synopsis + +Update a deployment parameter. + +``` +fmeserver deploymentparameters update [flags] +``` + +### Examples + +``` + + Examples: + # Update a deployment parameter with the name "myParam" and the value "myValue" + fmeserver deploymentparameter update --name myParam --value myValue + +``` + +### Options + +``` + -h, --help help for update + --name string Name of the deployment parameter to update. + --value string The value to set the deployment parameter to. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_engines.md b/docs/fmeserver_engines.md new file mode 100644 index 0000000..f466d5d --- /dev/null +++ b/docs/fmeserver_engines.md @@ -0,0 +1,50 @@ +## fmeserver engines + +Get information about the FME Engines + +### Synopsis + +Gets information and status about FME Engines currently connected to FME Server + +``` +fmeserver engines [flags] +``` + +### Examples + +``` + + # List all engines + fmeserver engines + + # Output number of engines + fmeserver engines --count + + # Output engines in json form + fmeserver engines --json + + # Output just the names of the engines with no column headers + fmeserver engines --output=custom-columns=NAME:.instanceName --no-headers +``` + +### Options + +``` + --count Prints the total count of engines. + -h, --help help for engines + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_healthcheck.md b/docs/fmeserver_healthcheck.md new file mode 100644 index 0000000..22b92dc --- /dev/null +++ b/docs/fmeserver_healthcheck.md @@ -0,0 +1,50 @@ +## fmeserver healthcheck + +Retrieves the health status of FME Server + +### Synopsis + +Retrieves the health status of FME Server. The health status is normal if the FME Server REST API is responsive. Note that this endpoint does not require authentication. Load balancer or other systems can monitor FME Server using this endpoint without supplying token or password credentials. + +``` +fmeserver healthcheck [flags] +``` + +### Examples + +``` + + # Check if the FME Server is healthy and accepting requests + fmeserver healthcheck + + # Check if the FME Server is healthy and ready to process jobs + fmeserver healthcheck --ready + + # Check if the FME Server is healthy and output in json + fmeserver healthcheck --json + + # Check that the FME Server is healthy and output just the status + fmeserver healthcheck --output=custom-columns=STATUS:.status +``` + +### Options + +``` + -h, --help help for healthcheck + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") + --ready The health check will report the status of FME Server if it is ready to process jobs. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_info.md b/docs/fmeserver_info.md new file mode 100644 index 0000000..26e271a --- /dev/null +++ b/docs/fmeserver_info.md @@ -0,0 +1,47 @@ +## fmeserver info + +Retrieves build, version and time information about FME Server + +### Synopsis + +Retrieves build, version and time information about FME Server + +``` +fmeserver info [flags] +``` + +### Examples + +``` + + # Output FME Server information in a table + fmeserver info + + # Output FME Server information in json + fmeserver info --json + + # Output just the build string with no column headers + fmeserver info --output=custom-columns="BUILD:.build" --no-headers + +``` + +### Options + +``` + -h, --help help for info + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_jobs.md b/docs/fmeserver_jobs.md new file mode 100644 index 0000000..843ee1a --- /dev/null +++ b/docs/fmeserver_jobs.md @@ -0,0 +1,67 @@ +## fmeserver jobs + +Lists jobs on FME Server + +### Synopsis + +Lists jobs on FME Server + +``` +fmeserver jobs [flags] +``` + +### Examples + +``` + + # List all jobs (currently limited to the most recent 1000) + fmeserver jobs --all + + # List all running jobs + fmeserver jobs --running + + # List all jobs from a given repository + fmeserver jobs --repository Samples + + # List all jobs that ran a given workspace + fmeserver jobs --repository Samples --workspace austinApartments.fmw + + # List all jobs in JSON format + fmeserver jobs --json + + # List the workspace, CPU time and peak memory usage for a given repository + fmeserver jobs --repository Samples --output="custom-columns=WORKSPACE:.workspace,CPU Time:.cpuTime,Peak Memory:.peakMemUsage" + +``` + +### Options + +``` + --active Retrieve active jobs + --all Retrieve all jobs + --completed Retrieve completed jobs + -h, --help help for jobs + --id int Specify the job id to display (default -1) + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") + --queued Retrieve queued jobs + --repository string If specified, only jobs from the specified repository will be returned. + --running Retrieve running jobs + --source-id string If specified along with source type, only jobs from the specified type with the specified id will be returned. For Automations, the source id is the automation id. For WorkspaceSubscriber, the source id is the id of the subscription. For Scheduler, the source id is the category and name of the schedule separated by '/'. For example, 'Category/Name'. + --source-type string If specified, only jobs run by this source type will be returned. + --user-name string If specified, only jobs run by the specified user will be returned. + --workspace string If specified along with repository, only jobs from the specified repository and workspace will be returned. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license.md b/docs/fmeserver_license.md new file mode 100644 index 0000000..2615112 --- /dev/null +++ b/docs/fmeserver_license.md @@ -0,0 +1,33 @@ +## fmeserver license + +Interact with licensing an FME Server + +### Synopsis + +Contains several subcommands for licensing tasks related to FME Server. + + +### Options + +``` + -h, --help help for license +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. +* [fmeserver license machinekey](fmeserver_license_machinekey.md) - Retrieves machine key of the machine running FME Server. +* [fmeserver license refresh](fmeserver_license_refresh.md) - Refreshes the installed license file with a current license from Safe Software. +* [fmeserver license request](fmeserver_license_request.md) - Request a license from the FME Server licensing server +* [fmeserver license requestfile](fmeserver_license_requestfile.md) - Generates a JSON file for requesting a FME Server license file. +* [fmeserver license status](fmeserver_license_status.md) - Retrieves status of the installed FME Server license. +* [fmeserver license systemcode](fmeserver_license_systemcode.md) - Retrieves system code of the machine running FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_machinekey.md b/docs/fmeserver_license_machinekey.md new file mode 100644 index 0000000..be0cfc6 --- /dev/null +++ b/docs/fmeserver_license_machinekey.md @@ -0,0 +1,30 @@ +## fmeserver license machinekey + +Retrieves machine key of the machine running FME Server. + +### Synopsis + +Retrieves machine key of the machine running FME Server. + +``` +fmeserver license machinekey [flags] +``` + +### Options + +``` + -h, --help help for machinekey +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_refresh.md b/docs/fmeserver_license_refresh.md new file mode 100644 index 0000000..aa3c2c0 --- /dev/null +++ b/docs/fmeserver_license_refresh.md @@ -0,0 +1,40 @@ +## fmeserver license refresh + +Refreshes the installed license file with a current license from Safe Software. + +### Synopsis + +Refreshes the installed license file with a current license from Safe Software. + +``` +fmeserver license refresh [flags] +``` + +### Examples + +``` + + # Refresh the license + fmeserver license refresh +``` + +### Options + +``` + -h, --help help for refresh + --wait Wait for licensing refresh to finish +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server +* [fmeserver license refresh status](fmeserver_license_refresh_status.md) - Check status of license refresh + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_refresh_status.md b/docs/fmeserver_license_refresh_status.md new file mode 100644 index 0000000..b80790d --- /dev/null +++ b/docs/fmeserver_license_refresh_status.md @@ -0,0 +1,46 @@ +## fmeserver license refresh status + +Check status of license refresh + +### Synopsis + +Check the status of a license refresh request. + +``` +fmeserver license refresh status [flags] +``` + +### Examples + +``` + + # Output the license refresh status as a table + fmeserver license refresh status + + # Output the license refresh status in json + fmeserver license refresh status --json + + # Output just the status message + fmeserver license refresh status --output custom-columns=STATUS:.status --no-headers +``` + +### Options + +``` + -h, --help help for status + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license refresh](fmeserver_license_refresh.md) - Refreshes the installed license file with a current license from Safe Software. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_request.md b/docs/fmeserver_license_request.md new file mode 100644 index 0000000..c1c8878 --- /dev/null +++ b/docs/fmeserver_license_request.md @@ -0,0 +1,54 @@ +## fmeserver license request + +Request a license from the FME Server licensing server + +### Synopsis + +Request a license file from the FME Server licensing server. First name, Last name and email are required for requesting a license file. + If no serial number is passed in, a trial license will be requested. + +``` +fmeserver license request [flags] +``` + +### Examples + +``` + + # Request a trial license and wait for it to be downloaded and installed + fmeserver license request --first-name "Billy" --last-name "Bob" --email "billy.bob@example.com" --company "Example Company Inc." --wait + + # Request a license with a serial number + fmeserver license request --first-name "Billy" --last-name "Bob" --email "billy.bob@example.com" --company "Example Company Inc." --serial-number "AAAA-BBBB-CCCC" + +``` + +### Options + +``` + --category string License Category + --company string Company for the licensing request + --email string Email address for license request. + --first-name string First name to use for license request. + -h, --help help for request + --industry string Industry for the licensing request + --last-name string Last name to use for license request. + --sales-source string Sales source + --serial-number string Serial Number for the license request. + --subscribe-to-updates Subscribe to Updates + --wait Wait for licensing request to finish +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server +* [fmeserver license request status](fmeserver_license_request_status.md) - Check status of license request + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_request_status.md b/docs/fmeserver_license_request_status.md new file mode 100644 index 0000000..8e03842 --- /dev/null +++ b/docs/fmeserver_license_request_status.md @@ -0,0 +1,46 @@ +## fmeserver license request status + +Check status of license request + +### Synopsis + +Check the status of a license request. + +``` +fmeserver license request status [flags] +``` + +### Examples + +``` + + # Output the license request status as a table + fmeserver license request status + + # Output the license Request status in json + fmeserver license request status --json + + # Output just the status message + fmeserver license request status --output custom-columns=STATUS:.status --no-headers +``` + +### Options + +``` + -h, --help help for status + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license request](fmeserver_license_request.md) - Request a license from the FME Server licensing server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_requestfile.md b/docs/fmeserver_license_requestfile.md new file mode 100644 index 0000000..14f1920 --- /dev/null +++ b/docs/fmeserver_license_requestfile.md @@ -0,0 +1,48 @@ +## fmeserver license requestfile + +Generates a JSON file for requesting a FME Server license file. + +### Synopsis + +Generates a JSON file for requesting a FME Server license file. + + Example: + + # Generate a license request file and output to the console + fmeserver license requestfile --first-name "Billy" --last-name "Bob" --email "billy.bob@example.com" --company "Example Company Inc." + + # Generate a license request file and output to a local file + fmeserver license requestfile --first-name "Billy" --last-name "Bob" --email "billy.bob@example.com" --company "Example Company Inc." --file my-request-file.json + +``` +fmeserver license requestfile [flags] +``` + +### Options + +``` + --category string License Category + --company string Company for the licensing request + --email string Email address for license request. + --file string Path to file to output to. + --first-name string First name to use for license request. + -h, --help help for requestfile + --industry string Industry for the licensing request + --last-name string Last name to use for license request. + --sales-source string Sales source + --serial-number string Serial Number for the license request. + --subscribe-to-updates Subscribe to Updates +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_status.md b/docs/fmeserver_license_status.md new file mode 100644 index 0000000..321f8c1 --- /dev/null +++ b/docs/fmeserver_license_status.md @@ -0,0 +1,32 @@ +## fmeserver license status + +Retrieves status of the installed FME Server license. + +### Synopsis + +Retrieves status of the installed FME Server license. + +``` +fmeserver license status [flags] +``` + +### Options + +``` + -h, --help help for status + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_systemcode.md b/docs/fmeserver_license_systemcode.md new file mode 100644 index 0000000..eceae3a --- /dev/null +++ b/docs/fmeserver_license_systemcode.md @@ -0,0 +1,30 @@ +## fmeserver license systemcode + +Retrieves system code of the machine running FME Server. + +### Synopsis + +Retrieves system code of the machine running FME Server. + +``` +fmeserver license systemcode [flags] +``` + +### Options + +``` + -h, --help help for systemcode +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_login.md b/docs/fmeserver_login.md new file mode 100644 index 0000000..07909d0 --- /dev/null +++ b/docs/fmeserver_login.md @@ -0,0 +1,47 @@ +## fmeserver login + +Save credentials for an FME Server + +### Synopsis + +Update the config file with the credentials to connect to FME Server. If just a URL is passed in, you will be prompted for a user and password for the FME Server. This will be used to generate an API token that will be saved to the config file for use connecting to FME Server. + Use the --token flag to pass in an existing API token. To log in with a password on the command line without being prompted, place the password in a text file and pass that in using the --password-file flag. + This will overwrite any existing credentials saved. + + Examples: + + # Prompt for user and password for the given FME Server URL + fmeserver login https://my-fmeserver.internal + + # Login to an FME Server using a pre-generated token + fmeserver login https://my-fmeserver.internal --token 5937391ad3a87f19ba14dc6082867373087d031b + + # Login to an FME Server using a passed in user and password file + fmeserver login https://my-fmeserver.internal --user admin --password passw0rd + +``` +fmeserver login [URL] [flags] +``` + +### Options + +``` + --expiration int The length of time to generate the token for in seconds. (default 2592000) + -h, --help help for login + -p, --password-file string A file containing the FME Server password for the user to generate an API token for. + -t, --token string The existing API token to use to connect to FME Server + -u, --user string The FME Server user to generate an API token for. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_migration.md b/docs/fmeserver_migration.md new file mode 100644 index 0000000..e8de684 --- /dev/null +++ b/docs/fmeserver_migration.md @@ -0,0 +1,27 @@ +## fmeserver migration + +Returns information on migration tasks using the tasks subcommand. + +### Synopsis + +Returns information on migration tasks using the tasks subcommand. + +### Options + +``` + -h, --help help for migration +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. +* [fmeserver migration tasks](fmeserver_migration_tasks.md) - Retrieves the records for all migration tasks. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_migration_tasks.md b/docs/fmeserver_migration_tasks.md new file mode 100644 index 0000000..af54865 --- /dev/null +++ b/docs/fmeserver_migration_tasks.md @@ -0,0 +1,58 @@ +## fmeserver migration tasks + +Retrieves the records for all migration tasks. + +### Synopsis + +Retrieves the records for all migration tasks. + +``` +fmeserver migration tasks [flags] +``` + +### Examples + +``` + + # Get all migration tasks + fmeserver migration tasks + + # Get all migration tasks in json + fmeserver migration tasks --json + + # Get the migration task for a given id + fmeserver migration tasks --id 1 + + # Output the migration log for a given id to the console + fmeserver migration tasks --id 1 --log + + # Output the migration log for a given id to a local file + fmeserver migration tasks --id 1 --log --file my-backup-log.txt + + # Output just the start and end time of the a given id + fmeserver migration tasks --id 1 --output="custom-columns=Start Time:.startDate,End Time:.finishedDate" +``` + +### Options + +``` + --file string File to save the log to. + -h, --help help for tasks + --id int Retrieves the record for a migration task according to the given ID. (default -1) + --log Downloads the log file of a migration task. + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver migration](fmeserver_migration.md) - Returns information on migration tasks using the tasks subcommand. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_projects.md b/docs/fmeserver_projects.md new file mode 100644 index 0000000..c4665f4 --- /dev/null +++ b/docs/fmeserver_projects.md @@ -0,0 +1,47 @@ +## fmeserver projects + +Lists all projects on the FME Server + +### Synopsis + +Lists all projects on the FME Server + +``` +fmeserver projects [flags] +``` + +### Examples + +``` + + # List all projects + fmeserver projects + + # List all projects owned by the user admin + fmeserver projects --owner admin +``` + +### Options + +``` + -h, --help help for projects + --name string Return a single project with the given name. + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") + --owner string If specified, only projects owned by the specified user will be returned. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. +* [fmeserver projects download](fmeserver_projects_download.md) - Downloads an FME Server Project +* [fmeserver projects upload](fmeserver_projects_upload.md) - Imports FME Server Projects from a downloaded import package. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_projects_download.md b/docs/fmeserver_projects_download.md new file mode 100644 index 0000000..2c5bf93 --- /dev/null +++ b/docs/fmeserver_projects_download.md @@ -0,0 +1,44 @@ +## fmeserver projects download + +Downloads an FME Server Project + +### Synopsis + +Backs up the FME Server configuration to a local file or to a shared resource location on the FME Server. + +``` +fmeserver projects download [flags] +``` + +### Examples + +``` + + # download a project named "Test Project" to a local file with default name + fmeserver projects download --name "Test Project" + + # download a project named "Test Project" to a local file named MyProject.fsproject + fmeserver projects download --name "Test Project" -f MyProject.fsproject +``` + +### Options + +``` + --exclude-sensitive-info Whether to exclude sensitive information from the exported package. Sensitive information will be excluded from connections, subscriptions, publications, schedule tasks, S3 resources, and user accounts. Other items in the project may still contain sensitive data, especially workspaces. Please be careful before sharing the project export pacakge with others. + -f, --file string Path to file to download the backup to. (default "ProjectPackage.fsproject") + -h, --help help for download + --name string Name of the project to download. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_projects_upload.md b/docs/fmeserver_projects_upload.md new file mode 100644 index 0000000..bfd09a9 --- /dev/null +++ b/docs/fmeserver_projects_upload.md @@ -0,0 +1,46 @@ +## fmeserver projects upload + +Imports FME Server Projects from a downloaded import package. + +### Synopsis + +Imports FME Server Projects from a downloaded import package. + +``` +fmeserver projects upload [flags] +``` + +### Examples + +``` + + # Restore from a backup in a local file + fmeserver projects upload --file ProjectPackage.fsproject + + # Restore from a backup in a local file using UPDATE mode + fmeserver projects upload --file ProjectPackage.fsproject --import-mode UPDATE +``` + +### Options + +``` + --disable-project-items Whether to disable items in the imported FME Server Projects. If true, items that are new or overwritten will be imported but disabled. If false, project items are imported as defined in the import package. + -f, --file string Path to backup file to upload to restore. Can be a local file or the relative path inside the specified shared resource. + -h, --help help for upload + --import-mode string To import only items in the import package that do not exist on the current instance, specify INSERT. To overwrite items on the current instance with those in the import package, specify UPDATE. Default is INSERT. (default "INSERT") + --pause-notifications Disable notifications for the duration of the restore. (default true) + --projects-import-mode string Import mode for projects. To import only projects in the import package that do not exist on the current instance, specify INSERT. To overwrite projects on the current instance with those in the import package, specify UPDATE. If not supplied, importMode will be used. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_repositories.md b/docs/fmeserver_repositories.md new file mode 100644 index 0000000..5fb754f --- /dev/null +++ b/docs/fmeserver_repositories.md @@ -0,0 +1,58 @@ +## fmeserver repositories + +List repositories + +### Synopsis + +Lists repositories on the given FME Server. + +``` +fmeserver repositories [flags] +``` + +### Examples + +``` + + Examples: + # List all repositories + fmeserver repositories + + # List all repositories owned by the admin user + fmeserver repositories --owner admin + + # List a single repository with the name "Samples" + fmeserver repositories --name Samples + + # Output just the name of all the repositories + fmeserver repositories --output=custom-columns=NAME:.name --no-headers + + # Output all repositories in json format + fmeserver repositories --json +``` + +### Options + +``` + --filter-string string Specify the output type. Should be one of table, json, or custom-columns. Only usable with V4 API. + -h, --help help for repositories + --name string If specified, only the repository with that name will be returned + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") + --owner string If specified, only repositories owned by the specified user uuid will be returned. With the V3 API, set this to the user name. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. +* [fmeserver repositories create](fmeserver_repositories_create.md) - Create a repository +* [fmeserver repositories delete](fmeserver_repositories_delete.md) - Delete a repository + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_repositories_create.md b/docs/fmeserver_repositories_create.md new file mode 100644 index 0000000..3cc0d90 --- /dev/null +++ b/docs/fmeserver_repositories_create.md @@ -0,0 +1,45 @@ +## fmeserver repositories create + +Create a repository + +### Synopsis + +Create a new repository. + +``` +fmeserver repositories create [flags] +``` + +### Examples + +``` + + Examples: + # Create a repository with the name "myRepository" and no description + fmeserver repositories create --name myRepository + + # Output just the name of all the repositories + fmeserver repositories create --name myRepository --description "This is my new repository" + +``` + +### Options + +``` + --description string Description of the new repository. + -h, --help help for create + --name string Name of the repository to create. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver repositories](fmeserver_repositories.md) - List repositories + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_repositories_delete.md b/docs/fmeserver_repositories_delete.md new file mode 100644 index 0000000..fe6e7ea --- /dev/null +++ b/docs/fmeserver_repositories_delete.md @@ -0,0 +1,45 @@ +## fmeserver repositories delete + +Delete a repository + +### Synopsis + +Delete a repository. + +``` +fmeserver repositories delete [flags] +``` + +### Examples + +``` + + Examples: + # Delete a repository with the name "myRepository" + fmeserver repositories delete --name myRepository + + # Delete a repository with the name "myRepository" and no confirmation + fmeserver repositories delete --name myRepository --no-prompt + +``` + +### Options + +``` + -h, --help help for delete + --name string Name of the repository to create. + -y, --no-prompt Description of the new repository. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver repositories](fmeserver_repositories.md) - List repositories + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_restore.md b/docs/fmeserver_restore.md new file mode 100644 index 0000000..90db0c4 --- /dev/null +++ b/docs/fmeserver_restore.md @@ -0,0 +1,56 @@ +## fmeserver restore + +Restores the FME Server configuration from an import package + +### Synopsis + +Restores the FME Server configuration from an import package + +``` +fmeserver restore [flags] +``` + +### Examples + +``` + + # Restore from a backup in a local file + fmeserver restore --file ServerConfigPackage.fsconfig + + # Restore from a backup in a local file using UPDATE mode + fmeserver restore --file ServerConfigPackage.fsconfig --import-mode UPDATE + + # Restore from a backup file stored in the Backup resource folder (FME_SHAREDRESOURCE_BACKUP) named ServerConfigPackage.fsconfig + fmeserver restore --resource --file ServerConfigPackage.fsconfig + + # Restore from a backup file stored in the Data resource folder (FME_SHAREDRESOURCE_DATA) named ServerConfigPackage.fsconfig and set a failure and success topic to notify + fmeserver restore --resource --resource-name FME_SHAREDRESOURCE_DATA --file ServerConfigPackage.fsconfig --failure-topic MY_FAILURE_TOPIC --success-topic MY_SUCCESS_TOPIC + +``` + +### Options + +``` + --failure-topic string Topic to notify on failure of the import. Default is MIGRATION_ASYNC_JOB_FAILURE. Only supported when restoring from a shared resource. + -f, --file string Path to backup file to upload to restore. Can be a local file or the relative path inside the specified shared resource. + -h, --help help for restore + --import-mode string To import only items in the import package that do not exist on the current instance, specify INSERT. To overwrite items on the current instance with those in the import package, specify UPDATE. Default is INSERT. (default "INSERT") + --pause-notifications Disable notifications for the duration of the restore. (default true) + --projects-import-mode string Import mode for projects. To import only projects in the import package that do not exist on the current instance, specify INSERT. To overwrite projects on the current instance with those in the import package, specify UPDATE. If not supplied, importMode will be used. + --resource Restore from a shared resource location instead of a local file. + --resource-name string Resource containing the import package. (default "FME_SHAREDRESOURCE_BACKUP") + --success-topic string Topic to notify on success of the import. Default is MIGRATION_ASYNC_JOB_SUCCESS. Only supported when restoring from a shared resource. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_run.md b/docs/fmeserver_run.md new file mode 100644 index 0000000..eaf228d --- /dev/null +++ b/docs/fmeserver_run.md @@ -0,0 +1,65 @@ +## fmeserver run + +Run a workspace on FME Server + +### Synopsis + +Run a workspace on FME Server + + Examples: + # Submit a job asynchronously + fmeserver run --repository Samples --workspace austinApartments.fmw + + # Submit a job and wait for it to complete + fmeserver run --repository Samples --workspace austinApartments.fmw --wait + + # Submit a job to a specific queue and set a time to live in the queue + fmeserver run --repository Samples --workspace austinApartments.fmw --tag Queue1 --time-to-live 120 + + # Submit a job and pass in a few published parameters + fmeserver run --repository Samples --workspace austinDownload.fmw --published-parameter-list THEMES=railroad,airports --published-parameter COORDSYS=TX83-CF + + # Submit a job, wait for it to complete, and customize the output + fmeserver run --repository Samples --workspace austinApartments.fmw --wait --output="custom-columns=Time Requested:.timeRequested,Time Started:.timeStarted,Time Finished:.timeFinished" + + # Upload a local file to use as the source data for the translation + fmeserver run --repository Samples --workspace austinApartments.fmw --file Landmarks-edited.sqlite --wait + +``` +fmeserver run [flags] +``` + +### Options + +``` + --repository string The name of the repository containing the workspace to run. + --workspace string The name of the workspace to run. + --wait Submit job and wait for it to finish. + --tag string The job routing tag for the request + --published-parameter stringArray Published parameters defined for this workspace. Specify as Key=Value. Can be passed in multiple times. For list parameters, use the --list-published-parameter flag. + --published-parameter-list stringArray A List-type published parameters defined for this workspace. Specify as Key=Value1,Value2. Can be passed in multiple times. + --file string Upload a local file Source dataset to use to run the workspace. Note this causes the translation to run in synchonous mode whether the --wait flag is passed in or not. + --run-until-canceled Runs a job until it is explicitly canceled. The job will run again regardless of whether the job completed successfully, failed, or the server crashed or was shut down. + --time-until-canceled int Time (in seconds) elapsed for a running job before it's cancelled. The minimum value is 1 second, values less than 1 second are ignored. (default -1) + --time-to-live int Time to live in the job queue (in seconds) (default -1) + --description string Description of the request. + --success-topic stringArray Topics to notify when the job succeeds. Can be specified more than once. + --failure-topic stringArray Topics to notify when the job fails. Can be specified more than once. + --node-manager-directive stringArray Additional NM Directives, which can include client-configured keys, to pass to the notification service for custom use by subscriptions. Specify as Key=Value Can be passed in multiple times. + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") + --no-headers Don't print column headers + -h, --help help for run +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_workspaces.md b/docs/fmeserver_workspaces.md new file mode 100644 index 0000000..b0b0279 --- /dev/null +++ b/docs/fmeserver_workspaces.md @@ -0,0 +1,56 @@ +## fmeserver workspaces + +List workspaces by repository + +### Synopsis + +Lists workspaces on the given FME Server in the repository. + +``` +fmeserver workspaces [flags] +``` + +### Examples + +``` + + Examples: + # List all workspaces in Samples repository + fmeserver workspaces --repository Samples + + # List all workspaces in the Samples repository and output it in json + fmeserver workspaces --repository Samples --json + + # List all workspaces in the Samples repository with custom columns showing the last publish date and number of times run + fmeserver workspaces --repository Samples --output="custom-columns=NAME:.name,PUBLISH DATE:.lastPublishDate,TOTAL RUNS:.totalRuns" + + # Get information on a single workspace + fmeserver workspaces --repository Samples --name austinApartments.fmw + + # Get the name, source format, and destination format for this workspace + fmeserver workspaces --repository Samples --name austinApartments.fmw --output=custom-columns=NAME:.name,SOURCE:.datasets.source[*].format,DEST:.datasets.destination[*].format +``` + +### Options + +``` + --filter-string string Specify the output type. Should be one of table, json, or custom-columns. Only usable with V4 API. + -h, --help help for workspaces + --name string If specified, get details about a specific workspace + --no-headers Don't print column headers + -o, --output string Specify the output type. Should be one of table, json, or custom-columns (default "table") + --repository string Name of repository to list workspaces in. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/.fmeserver-cli.yaml) + --json Output JSON +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + +###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/go.mod b/go.mod index 590c7ac..44b5071 100644 --- a/go.mod +++ b/go.mod @@ -9,6 +9,7 @@ require ( ) require ( + github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect github.com/mattn/go-colorable v0.1.12 // indirect @@ -18,6 +19,7 @@ require ( github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/rivo/uniseg v0.2.0 // indirect + github.com/russross/blackfriday/v2 v2.1.0 // indirect golang.org/x/term v0.3.0 // indirect gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect ) diff --git a/go.sum b/go.sum index 9fec246..2ae27ae 100644 --- a/go.sum +++ b/go.sum @@ -50,6 +50,7 @@ github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDk github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= +github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.17 h1:QeVUsEDNrLBW4tMgZHvxy18sKtr6VI492kBhUfhDJNI= github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= @@ -176,6 +177,7 @@ github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/rogpeppe/go-internal v1.6.1 h1:/FiVV8dS/e+YqF2JvO3yXRFbBLTIuSDkuC7aBOAvL+k= +github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/spf13/afero v1.9.2 h1:j49Hj62F0n+DaZ1dDCvhABaPNSGNkt32oRFxI33IEMw= github.com/spf13/afero v1.9.2/go.mod h1:iUV7ddyEEZPO5gA3zD4fJt6iStLlL+Lg4m2cihcDf8Y= From 3a63991ba74c590e1080bd36a814d9e0959ddcad Mon Sep 17 00:00:00 2001 From: Grant Arnold Date: Thu, 9 Feb 2023 16:04:56 -0800 Subject: [PATCH 2/4] Remove autogen tag on doc. --- cmd/root.go | 13 +++++++------ docs/fmeserver.md | 1 - docs/fmeserver_backup.md | 1 - docs/fmeserver_cancel.md | 1 - docs/fmeserver_deploymentparameters.md | 1 - docs/fmeserver_deploymentparameters_create.md | 1 - docs/fmeserver_deploymentparameters_delete.md | 1 - docs/fmeserver_deploymentparameters_update.md | 1 - docs/fmeserver_engines.md | 1 - docs/fmeserver_healthcheck.md | 1 - docs/fmeserver_info.md | 1 - docs/fmeserver_jobs.md | 1 - docs/fmeserver_license.md | 1 - docs/fmeserver_license_machinekey.md | 1 - docs/fmeserver_license_refresh.md | 1 - docs/fmeserver_license_refresh_status.md | 1 - docs/fmeserver_license_request.md | 1 - docs/fmeserver_license_request_status.md | 1 - docs/fmeserver_license_requestfile.md | 1 - docs/fmeserver_license_status.md | 1 - docs/fmeserver_license_systemcode.md | 1 - docs/fmeserver_login.md | 1 - docs/fmeserver_migration.md | 1 - docs/fmeserver_migration_tasks.md | 1 - docs/fmeserver_projects.md | 1 - docs/fmeserver_projects_download.md | 1 - docs/fmeserver_projects_upload.md | 1 - docs/fmeserver_repositories.md | 1 - docs/fmeserver_repositories_create.md | 1 - docs/fmeserver_repositories_delete.md | 1 - docs/fmeserver_restore.md | 1 - docs/fmeserver_run.md | 1 - docs/fmeserver_workspaces.md | 1 - 33 files changed, 7 insertions(+), 38 deletions(-) diff --git a/cmd/root.go b/cmd/root.go index b38cd99..af2b281 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -28,12 +28,13 @@ var rootCmd = NewRootCommand() func NewRootCommand() *cobra.Command { cmds := &cobra.Command{ - Use: "fmeserver", - Short: "A command line interface for interacting with FME Server.", - Long: `A command line interface for interacting with FME Server. See available commands below. Get started with the login command.`, - Version: appVersion, - SilenceErrors: true, - SilenceUsage: true, + Use: "fmeserver", + Short: "A command line interface for interacting with FME Server.", + Long: `A command line interface for interacting with FME Server. See available commands below. Get started with the login command.`, + Version: appVersion, + SilenceErrors: true, + SilenceUsage: true, + DisableAutoGenTag: true, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { // make sure the config file is set up correctly _, err := os.Stat(viper.ConfigFileUsed()) diff --git a/docs/fmeserver.md b/docs/fmeserver.md index 571321a..058af04 100644 --- a/docs/fmeserver.md +++ b/docs/fmeserver.md @@ -32,4 +32,3 @@ A command line interface for interacting with FME Server. See available commands * [fmeserver run](fmeserver_run.md) - Run a workspace on FME Server * [fmeserver workspaces](fmeserver_workspaces.md) - List workspaces by repository -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_backup.md b/docs/fmeserver_backup.md index 5ac08c9..42cdb6c 100644 --- a/docs/fmeserver_backup.md +++ b/docs/fmeserver_backup.md @@ -44,4 +44,3 @@ fmeserver backup [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_cancel.md b/docs/fmeserver_cancel.md index 2ec310f..3787267 100644 --- a/docs/fmeserver_cancel.md +++ b/docs/fmeserver_cancel.md @@ -37,4 +37,3 @@ fmeserver cancel [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters.md b/docs/fmeserver_deploymentparameters.md index b69acaa..fceadf1 100644 --- a/docs/fmeserver_deploymentparameters.md +++ b/docs/fmeserver_deploymentparameters.md @@ -48,4 +48,3 @@ fmeserver deploymentparameters [flags] * [fmeserver deploymentparameters delete](fmeserver_deploymentparameters_delete.md) - Delete a deployment parameter * [fmeserver deploymentparameters update](fmeserver_deploymentparameters_update.md) - Update a deployment parameter -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters_create.md b/docs/fmeserver_deploymentparameters_create.md index 883eabc..5d2033b 100644 --- a/docs/fmeserver_deploymentparameters_create.md +++ b/docs/fmeserver_deploymentparameters_create.md @@ -39,4 +39,3 @@ fmeserver deploymentparameters create [flags] * [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters_delete.md b/docs/fmeserver_deploymentparameters_delete.md index 2275027..713cc7e 100644 --- a/docs/fmeserver_deploymentparameters_delete.md +++ b/docs/fmeserver_deploymentparameters_delete.md @@ -42,4 +42,3 @@ fmeserver deploymentparameters delete [flags] * [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_deploymentparameters_update.md b/docs/fmeserver_deploymentparameters_update.md index 9bb0ebe..418e457 100644 --- a/docs/fmeserver_deploymentparameters_update.md +++ b/docs/fmeserver_deploymentparameters_update.md @@ -39,4 +39,3 @@ fmeserver deploymentparameters update [flags] * [fmeserver deploymentparameters](fmeserver_deploymentparameters.md) - List Deployment Parameters -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_engines.md b/docs/fmeserver_engines.md index f466d5d..63c964e 100644 --- a/docs/fmeserver_engines.md +++ b/docs/fmeserver_engines.md @@ -47,4 +47,3 @@ fmeserver engines [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_healthcheck.md b/docs/fmeserver_healthcheck.md index 22b92dc..aa24310 100644 --- a/docs/fmeserver_healthcheck.md +++ b/docs/fmeserver_healthcheck.md @@ -47,4 +47,3 @@ fmeserver healthcheck [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_info.md b/docs/fmeserver_info.md index 26e271a..2c649e9 100644 --- a/docs/fmeserver_info.md +++ b/docs/fmeserver_info.md @@ -44,4 +44,3 @@ fmeserver info [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_jobs.md b/docs/fmeserver_jobs.md index 843ee1a..6a0d20a 100644 --- a/docs/fmeserver_jobs.md +++ b/docs/fmeserver_jobs.md @@ -64,4 +64,3 @@ fmeserver jobs [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license.md b/docs/fmeserver_license.md index 2615112..027d9f5 100644 --- a/docs/fmeserver_license.md +++ b/docs/fmeserver_license.md @@ -30,4 +30,3 @@ Contains several subcommands for licensing tasks related to FME Server. * [fmeserver license status](fmeserver_license_status.md) - Retrieves status of the installed FME Server license. * [fmeserver license systemcode](fmeserver_license_systemcode.md) - Retrieves system code of the machine running FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_machinekey.md b/docs/fmeserver_license_machinekey.md index be0cfc6..3eb2e42 100644 --- a/docs/fmeserver_license_machinekey.md +++ b/docs/fmeserver_license_machinekey.md @@ -27,4 +27,3 @@ fmeserver license machinekey [flags] * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_refresh.md b/docs/fmeserver_license_refresh.md index aa3c2c0..b44cf87 100644 --- a/docs/fmeserver_license_refresh.md +++ b/docs/fmeserver_license_refresh.md @@ -37,4 +37,3 @@ fmeserver license refresh [flags] * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server * [fmeserver license refresh status](fmeserver_license_refresh_status.md) - Check status of license refresh -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_refresh_status.md b/docs/fmeserver_license_refresh_status.md index b80790d..757c0bc 100644 --- a/docs/fmeserver_license_refresh_status.md +++ b/docs/fmeserver_license_refresh_status.md @@ -43,4 +43,3 @@ fmeserver license refresh status [flags] * [fmeserver license refresh](fmeserver_license_refresh.md) - Refreshes the installed license file with a current license from Safe Software. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_request.md b/docs/fmeserver_license_request.md index c1c8878..3a30ad4 100644 --- a/docs/fmeserver_license_request.md +++ b/docs/fmeserver_license_request.md @@ -51,4 +51,3 @@ fmeserver license request [flags] * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server * [fmeserver license request status](fmeserver_license_request_status.md) - Check status of license request -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_request_status.md b/docs/fmeserver_license_request_status.md index 8e03842..bb03098 100644 --- a/docs/fmeserver_license_request_status.md +++ b/docs/fmeserver_license_request_status.md @@ -43,4 +43,3 @@ fmeserver license request status [flags] * [fmeserver license request](fmeserver_license_request.md) - Request a license from the FME Server licensing server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_requestfile.md b/docs/fmeserver_license_requestfile.md index 14f1920..f59f3b5 100644 --- a/docs/fmeserver_license_requestfile.md +++ b/docs/fmeserver_license_requestfile.md @@ -45,4 +45,3 @@ fmeserver license requestfile [flags] * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_status.md b/docs/fmeserver_license_status.md index 321f8c1..68ebb45 100644 --- a/docs/fmeserver_license_status.md +++ b/docs/fmeserver_license_status.md @@ -29,4 +29,3 @@ fmeserver license status [flags] * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_license_systemcode.md b/docs/fmeserver_license_systemcode.md index eceae3a..b227489 100644 --- a/docs/fmeserver_license_systemcode.md +++ b/docs/fmeserver_license_systemcode.md @@ -27,4 +27,3 @@ fmeserver license systemcode [flags] * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_login.md b/docs/fmeserver_login.md index 07909d0..82a7e3e 100644 --- a/docs/fmeserver_login.md +++ b/docs/fmeserver_login.md @@ -44,4 +44,3 @@ fmeserver login [URL] [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_migration.md b/docs/fmeserver_migration.md index e8de684..97a0be8 100644 --- a/docs/fmeserver_migration.md +++ b/docs/fmeserver_migration.md @@ -24,4 +24,3 @@ Returns information on migration tasks using the tasks subcommand. * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. * [fmeserver migration tasks](fmeserver_migration_tasks.md) - Retrieves the records for all migration tasks. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_migration_tasks.md b/docs/fmeserver_migration_tasks.md index af54865..b8abee9 100644 --- a/docs/fmeserver_migration_tasks.md +++ b/docs/fmeserver_migration_tasks.md @@ -55,4 +55,3 @@ fmeserver migration tasks [flags] * [fmeserver migration](fmeserver_migration.md) - Returns information on migration tasks using the tasks subcommand. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_projects.md b/docs/fmeserver_projects.md index c4665f4..0fb5a37 100644 --- a/docs/fmeserver_projects.md +++ b/docs/fmeserver_projects.md @@ -44,4 +44,3 @@ fmeserver projects [flags] * [fmeserver projects download](fmeserver_projects_download.md) - Downloads an FME Server Project * [fmeserver projects upload](fmeserver_projects_upload.md) - Imports FME Server Projects from a downloaded import package. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_projects_download.md b/docs/fmeserver_projects_download.md index 2c5bf93..eac0beb 100644 --- a/docs/fmeserver_projects_download.md +++ b/docs/fmeserver_projects_download.md @@ -41,4 +41,3 @@ fmeserver projects download [flags] * [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_projects_upload.md b/docs/fmeserver_projects_upload.md index bfd09a9..2bd6c13 100644 --- a/docs/fmeserver_projects_upload.md +++ b/docs/fmeserver_projects_upload.md @@ -43,4 +43,3 @@ fmeserver projects upload [flags] * [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_repositories.md b/docs/fmeserver_repositories.md index 5fb754f..d873bc3 100644 --- a/docs/fmeserver_repositories.md +++ b/docs/fmeserver_repositories.md @@ -55,4 +55,3 @@ fmeserver repositories [flags] * [fmeserver repositories create](fmeserver_repositories_create.md) - Create a repository * [fmeserver repositories delete](fmeserver_repositories_delete.md) - Delete a repository -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_repositories_create.md b/docs/fmeserver_repositories_create.md index 3cc0d90..a9c7bb5 100644 --- a/docs/fmeserver_repositories_create.md +++ b/docs/fmeserver_repositories_create.md @@ -42,4 +42,3 @@ fmeserver repositories create [flags] * [fmeserver repositories](fmeserver_repositories.md) - List repositories -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_repositories_delete.md b/docs/fmeserver_repositories_delete.md index fe6e7ea..edfcf69 100644 --- a/docs/fmeserver_repositories_delete.md +++ b/docs/fmeserver_repositories_delete.md @@ -42,4 +42,3 @@ fmeserver repositories delete [flags] * [fmeserver repositories](fmeserver_repositories.md) - List repositories -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_restore.md b/docs/fmeserver_restore.md index 90db0c4..6ec79ca 100644 --- a/docs/fmeserver_restore.md +++ b/docs/fmeserver_restore.md @@ -53,4 +53,3 @@ fmeserver restore [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_run.md b/docs/fmeserver_run.md index eaf228d..aa8dbb8 100644 --- a/docs/fmeserver_run.md +++ b/docs/fmeserver_run.md @@ -62,4 +62,3 @@ fmeserver run [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 diff --git a/docs/fmeserver_workspaces.md b/docs/fmeserver_workspaces.md index b0b0279..db40f1b 100644 --- a/docs/fmeserver_workspaces.md +++ b/docs/fmeserver_workspaces.md @@ -53,4 +53,3 @@ fmeserver workspaces [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -###### Auto generated by spf13/cobra on 9-Feb-2023 From be8568bad6ba02aa5d64412bc914fb8b2c94dda2 Mon Sep 17 00:00:00 2001 From: Grant Arnold Date: Fri, 10 Feb 2023 15:29:34 -0800 Subject: [PATCH 3/4] Add link to custom columns doc. --- docs/custom-columns.md | 202 +++++++++++++++++++++++++++++++++++++++++ docs/fmeserver.md | 1 + 2 files changed, 203 insertions(+) create mode 100644 docs/custom-columns.md diff --git a/docs/custom-columns.md b/docs/custom-columns.md new file mode 100644 index 0000000..9defb29 --- /dev/null +++ b/docs/custom-columns.md @@ -0,0 +1,202 @@ +## Custom Columns + +Many of the commands in the CLI support an output type of `custom-columns`. This allows you to output specific fields to the output table that exist in the raw JSON that the command returns. This can be helpful to get specialized information, or if a pipeline requires a certain field to pass into another command. + +### General Syntax + +The `custom-columns` output type will take a comma delimited list of header and value pairs that will make up the output table. The general syntax is: +``` +HEADERNAME:.jsonPathForValue +``` +`HEADERNAME` will be the heading of the column in the table, and `.jsonPathForValue` will be the JSONPath expression to retrieve the data for that column from the returned JSON. This allows you to dynamically set column values to whatever data you need from the json. + +### JSONPath + +JSONPath is a query language for JSON. The implementation of it in the FME Server CLI is heavily based on the implementation of it for the `kubectl` CLI for Kubernetes. More detailed documentation on how to use it can be found in the [Kubernetes documentation](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for things that are not covered here. + +### How to use it + +When crafting a `custom-column` output for a given command that supports it in the CLI, a good place to start is outputing the raw JSON for that command to see what fields are available. + +For example, let's output all the workspaces in the `Samples` repository. + +``` +> fmeserver workspaces --repository Samples + NAME TITLE LAST SAVE DATE + austinApartments.fmw City of Austin: Apartments and other (SPATIALITE 2 KML) 2022-06-15 10:59:24 +0000 UTC + austinDownload.fmw City of Austin: Data Download 2022-06-15 13:40:29 +0000 UTC + earthquakesextrusion.fmw Earthquakes: GeoJSON to KML Diagrams 2022-06-15 15:52:07 +0000 UTC + easyTranslator.fmw Generic format translator 2022-06-15 15:56:11 +0000 UTC +``` +In order to see what data we can output in our `custom-columns` output, we should take a look at the raw JSON: +``` +> fmeserver workspaces --repository Samples --json +{ + "items": [ + { + "name": "austinApartments.fmw", + "title": "City of Austin: Apartments and other (SPATIALITE 2 KML)", + "description": "", + "type": "workspace", + "repositoryName": "Samples", + "lastSaveDate": "2022-06-15T10:59:24.000Z", + "lastPublishDate": "2023-02-03T01:03:26.513Z", + "lastPublishUserId": "fb2dd313-e5cf-432e-a24a-814e46929ab7", + "lastPublishUser": "admin", + "totalFileSize": 6680576, + "fileCount": 1, + "averageCpuPercent": 0.0, + "averagePeakMemoryUsage": 0, + "averageCpuTime": 0, + "totalRuns": 0, + "averageElapsedTime": 0, + "favorite": false + }, + ... + ], + "totalCount": 4, + "limit": 100, + "offset": 0 +} +``` +The output has been truncated here to organize it better, but we can now see what is available for each workspace. In the FME Server CLI, the JSONPath query is applied to each item in the `items` array automatically. This means to access a field, we would do it from the item level. We also can omit the `$` from the start of the JSONPath query. For example, to access the field `averageCpuPercent`, the JSONPath query we need for the columns is simply `.averageCpuPercent`. + +This means to output the workspace name along with the average CPU percent and average elapsed time, our CLI command looks like this: +``` +> fmeserver workspaces --repository Samples --output custom-columns="NAME:.name,CPU PERCENT:.averageCpuPercent,ELAPSED TIME:.averageElapsedTime" + NAME CPU PERCENT ELAPSED TIME + austinApartments.fmw 13.242375601926163 1246 + austinDownload.fmw 63.6535552193646 2644 + earthquakesextrusion.fmw 37.996127783155856 2066 + easyTranslator.fmw 61.24852767962309 849 +``` + +For a slightly more complicated example, specifying a specific workspace gives more data: +``` +> fmeserver workspaces --repository Samples --name "austinApartments.fmw" --json +{ + "name": "austinApartments.fmw", + "title": "City of Austin: Apartments and other (SPATIALITE 2 KML)", + "type": "workspace", + "buildNumber": 22337, + "category": "", + "history": "", + "lastSaveDate": "2022-06-15T10:59:24.000Z", + "lastPublishDate": "2023-02-03T01:03:26.513Z", + "lastSaveBuild": "FME(R) 2022.0.0.0 (20220428 - Build 22337 - WIN64)", + "legalTermsConditions": "", + "properties": [ + { + "attributes": {}, + "category": "fmedatadownload_FMEUSERPROPDATA", + "name": "ADVANCED", + "value": "" + }, + ... + ], + "requirements": "", + "requirementsKeyword": "", + "resources": [ + { + "name": "Landmarks.sqlite", + "size": 6680576 + } + ], + "usage": "", + "userName": "admin", + "fileSize": 136390, + "favorite": false, + "averageCpuPercent": 13.242375601926163, + "averagePeakMemoryUsage": 5736760, + "averageCpuTime": 165, + "totalRuns": 1, + "averageElapsedTime": 1246, + "description": "", + "datasets": { + "source": [ + { + "featureTypes": [ + { + "attributes": [ + { + "decimals": 0, + "name": "CFCC", + "type": "varchar", + "width": 4 + }, + ... + ], + "description": "", + "name": "Landmarks", + "properties": [] + } + ], + "format": "SPATIALITE_NATIVE", + "location": "$(FME_MF_DIR_USERTYPED)\\Landmarks.sqlite", + "name": "SPATIALITE_NATIVE_1", + "properties": [ + { + "attributes": {}, + "category": "DATASET_DESCRIPTION", + "name": "SPATIALITE_NATIVE_1", + "value": "Landmarks.sqlite [SPATIALITE_NATIVE]" + }, + ... + ], + "source": true + } + ], + "destination": [ + { + "featureTypes": [ + { + "attributes": [ + { + "decimals": 0, + "name": "CFCC", + "type": "kml_char", + "width": 4 + }, + ... + ], + "description": "", + "name": "Landmarks", + "properties": [] + } + ], + "format": "OGCKML", + "location": "/data/fmeserverdata/resources/system/temp/engineresults\\austinApartments.kml", + "name": "OGCKML_1", + "properties": [ + { + "attributes": {}, + "category": "DATASET_DESCRIPTION", + "name": "OGCKML_1", + "value": "austinApartments.kml [OGCKML]" + }, + ... + ], + "source": false + } + ] + }, + "services": { + ... + } + }, + "parameters": [] +} +``` + +The JSON about a single workspace includes information on source and destination datasets, that are stored in a JSON list. In JSONPath, lists are accessed using `[]`, with a specific index being specified as a number such as `[0]`, or all results from that list being denoted as `[*]`. For examples, if we want to get all the source formats for this workspace, we would use the JSonPath query `.datasets.source[*].format`. A full example: + +``` +> fmeserver workspaces --repository Samples --name "austinApartments.fmw" --output custom-columns="NAME:.name,SOURCE:.datasets.source[*].format,DEST:datasets.destination[*].format" + NAME SOURCE DEST + austinApartments.fmw SPATIALITE_NATIVE OGCKML +``` + +### SEE ALSO + +* [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. + diff --git a/docs/fmeserver.md b/docs/fmeserver.md index 058af04..0c2c1de 100644 --- a/docs/fmeserver.md +++ b/docs/fmeserver.md @@ -31,4 +31,5 @@ A command line interface for interacting with FME Server. See available commands * [fmeserver restore](fmeserver_restore.md) - Restores the FME Server configuration from an import package * [fmeserver run](fmeserver_run.md) - Run a workspace on FME Server * [fmeserver workspaces](fmeserver_workspaces.md) - List workspaces by repository +* [Custom Columns output](custom-columns.md) - In depth documentation on using the `custom-columns` output type From b9162e59362bc5bcbc4ac5e7e7b62846a6f09a53 Mon Sep 17 00:00:00 2001 From: Grant Arnold Date: Fri, 10 Feb 2023 23:52:00 +0000 Subject: [PATCH 4/4] Some small help tweaks. --- cmd/jobs.go | 2 +- cmd/migrationTasks.go | 4 ++-- cmd/projects.go | 4 ++-- cmd/projects_download.go | 2 +- cmd/projects_upload.go | 4 ++-- cmd/refreshStatus.go | 2 +- cmd/repositories.go | 2 +- cmd/repositories_create.go | 2 +- cmd/repositories_delete.go | 2 +- cmd/requestStatus.go | 2 +- cmd/run.go | 4 ++-- cmd/workspaces.go | 9 ++++++--- docs/fmeserver.md | 6 +++--- docs/fmeserver_jobs.md | 2 +- docs/fmeserver_license_refresh.md | 2 +- docs/fmeserver_license_refresh_status.md | 2 +- docs/fmeserver_license_request.md | 2 +- docs/fmeserver_license_request_status.md | 2 +- docs/fmeserver_migration.md | 2 +- docs/fmeserver_migration_tasks.md | 4 ++-- docs/fmeserver_projects.md | 6 +++--- docs/fmeserver_projects_download.md | 4 ++-- docs/fmeserver_projects_upload.md | 6 +++--- docs/fmeserver_repositories.md | 6 +++--- docs/fmeserver_repositories_create.md | 2 +- docs/fmeserver_repositories_delete.md | 2 +- docs/fmeserver_run.md | 4 ++-- docs/fmeserver_workspaces.md | 9 ++++++--- 28 files changed, 53 insertions(+), 47 deletions(-) diff --git a/cmd/jobs.go b/cmd/jobs.go index a043d6e..b9ff65b 100644 --- a/cmd/jobs.go +++ b/cmd/jobs.go @@ -67,7 +67,7 @@ func newJobsCmd() *cobra.Command { cmd := &cobra.Command{ Use: "jobs", Short: "Lists jobs on FME Server", - Long: "Lists jobs on FME Server", + Long: "Lists running, queued, and/or queued jobs on FME Server. Pass in a job id to get information on a specific job.", Example: ` # List all jobs (currently limited to the most recent 1000) diff --git a/cmd/migrationTasks.go b/cmd/migrationTasks.go index 26eb82e..29dd6ce 100644 --- a/cmd/migrationTasks.go +++ b/cmd/migrationTasks.go @@ -57,8 +57,8 @@ func newMigrationTasksCmd() *cobra.Command { f := migrationTasksFlags{} cmd := &cobra.Command{ Use: "tasks", - Short: "Retrieves the records for all migration tasks.", - Long: "Retrieves the records for all migration tasks.", + Short: "Retrieves the records for migration tasks.", + Long: "Retrieves the records for migration tasks. Get all migration tasks or for a specific task by passing in the id.", Example: ` # Get all migration tasks fmeserver migration tasks diff --git a/cmd/projects.go b/cmd/projects.go index 34e83d4..327fb0a 100644 --- a/cmd/projects.go +++ b/cmd/projects.go @@ -99,8 +99,8 @@ func newProjectsCmd() *cobra.Command { f := projectsFlags{} cmd := &cobra.Command{ Use: "projects", - Short: "Lists all projects on the FME Server", - Long: "Lists all projects on the FME Server", + Short: "Lists projects on the FME Server", + Long: "Lists projects on the FME Server. Pass in a name to retrieve information on a single project.", Example: ` # List all projects fmeserver projects diff --git a/cmd/projects_download.go b/cmd/projects_download.go index 940f6f5..110b45d 100644 --- a/cmd/projects_download.go +++ b/cmd/projects_download.go @@ -26,7 +26,7 @@ func newProjectDownloadCmd() *cobra.Command { cmd := &cobra.Command{ Use: "download", Short: "Downloads an FME Server Project", - Long: "Backs up the FME Server configuration to a local file or to a shared resource location on the FME Server.", + Long: "Downloads an FME Server Project to a local file. Useful for backing up or moving a project to another FME Server.", PreRunE: func(cmd *cobra.Command, args []string) error { return nil diff --git a/cmd/projects_upload.go b/cmd/projects_upload.go index c54b3f4..6ebbae8 100644 --- a/cmd/projects_upload.go +++ b/cmd/projects_upload.go @@ -28,8 +28,8 @@ func newProjectUploadCmd() *cobra.Command { f := projectUploadFlags{} cmd := &cobra.Command{ Use: "upload", - Short: "Imports FME Server Projects from a downloaded import package.", - Long: "Imports FME Server Projects from a downloaded import package.", + Short: "Imports FME Server Projects from a downloaded package.", + Long: "Imports FME Server Projects from a downloaded package. Useful for moving a project from one FME Server to another.", PreRunE: func(cmd *cobra.Command, args []string) error { // verify import mode is valid if f.importMode != "UPDATE" && f.importMode != "INSERT" { diff --git a/cmd/refreshStatus.go b/cmd/refreshStatus.go index 78534ef..5322922 100644 --- a/cmd/refreshStatus.go +++ b/cmd/refreshStatus.go @@ -20,7 +20,7 @@ func newRefreshStatusCmd() *cobra.Command { f := licenseRefreshStatusFlags{} cmd := &cobra.Command{ Use: "status", - Short: "Check status of license refresh", + Short: "Check the status of a license refresh request.", Long: "Check the status of a license refresh request.", Example: ` # Output the license refresh status as a table diff --git a/cmd/repositories.go b/cmd/repositories.go index 79cfee5..af29bea 100644 --- a/cmd/repositories.go +++ b/cmd/repositories.go @@ -64,7 +64,7 @@ func newRepositoryCmd() *cobra.Command { cmd := &cobra.Command{ Use: "repositories", Short: "List repositories", - Long: `Lists repositories on the given FME Server.`, + Long: `Lists repositories on the given FME Server. Pass in a name to get information on a specific repository.`, Example: ` Examples: # List all repositories diff --git a/cmd/repositories_create.go b/cmd/repositories_create.go index c863d1d..48610bb 100644 --- a/cmd/repositories_create.go +++ b/cmd/repositories_create.go @@ -29,7 +29,7 @@ func newRepositoryCreateCmd() *cobra.Command { f := repositoryCreateFlags{} cmd := &cobra.Command{ Use: "create", - Short: "Create a repository", + Short: "Create a new repository.", Long: `Create a new repository.`, Example: ` Examples: diff --git a/cmd/repositories_delete.go b/cmd/repositories_delete.go index 046c0a1..2c1c8af 100644 --- a/cmd/repositories_delete.go +++ b/cmd/repositories_delete.go @@ -22,7 +22,7 @@ func newRepositoryDeleteCmd() *cobra.Command { f := repositoryDeleteFlags{} cmd := &cobra.Command{ Use: "delete", - Short: "Delete a repository", + Short: "Delete a repository.", Long: `Delete a repository.`, Example: ` Examples: diff --git a/cmd/requestStatus.go b/cmd/requestStatus.go index 7ee4173..bfece6d 100644 --- a/cmd/requestStatus.go +++ b/cmd/requestStatus.go @@ -20,7 +20,7 @@ func newLicenseRequestStatusCmd() *cobra.Command { f := licenseRequestStatusFlags{} cmd := &cobra.Command{ Use: "status", - Short: "Check status of license request", + Short: "Check the status of a license request.", Long: "Check the status of a license request.", Example: ` # Output the license request status as a table diff --git a/cmd/run.go b/cmd/run.go index c39d0c2..309db9b 100644 --- a/cmd/run.go +++ b/cmd/run.go @@ -94,8 +94,8 @@ func newRunCmd() *cobra.Command { f := runFlags{} cmd := &cobra.Command{ Use: "run", - Short: "Run a workspace on FME Server", - Long: `Run a workspace on FME Server + Short: "Run a workspace on FME Server.", + Long: `Run a workspace on FME Server. Examples: # Submit a job asynchronously diff --git a/cmd/workspaces.go b/cmd/workspaces.go index 6b4b07b..20f6493 100644 --- a/cmd/workspaces.go +++ b/cmd/workspaces.go @@ -335,10 +335,13 @@ func newWorkspaceCmd() *cobra.Command { f := workspaceFlags{} cmd := &cobra.Command{ Use: "workspaces", - Short: "List workspaces by repository", - Long: `Lists workspaces on the given FME Server in the repository.`, + Short: "List workspaces.", + Long: `Lists workspaces that exist on the FME Server. Filter by repository, specify a name to retrieve a specific workspace, or specify a filter string to narrow down by name or title.`, Example: ` Examples: + # List all workspaces on the FME Server + fmeserver workspaces + # List all workspaces in Samples repository fmeserver workspaces --repository Samples @@ -383,7 +386,7 @@ func newWorkspaceCmd() *cobra.Command { cmd.Flags().StringVar(&f.repository, "repository", "", "Name of repository to list workspaces in.") cmd.Flags().StringVar(&f.name, "name", "", "If specified, get details about a specific workspace") - cmd.Flags().StringVar(&f.filterString, "filter-string", "", "Specify the output type. Should be one of table, json, or custom-columns. Only usable with V4 API.") + cmd.Flags().StringVar(&f.filterString, "filter-string", "", "If specified, only workspaces with a matching name or title will be returned. Only usable with V4 API.") cmd.Flags().StringVarP(&f.outputType, "output", "o", "table", "Specify the output type. Should be one of table, json, or custom-columns") cmd.Flags().BoolVar(&f.noHeaders, "no-headers", false, "Don't print column headers") cmd.Flags().Var(&f.apiVersion, "api-version", "The api version to use when contacting FME Server. Must be one of v3 or v4") diff --git a/docs/fmeserver.md b/docs/fmeserver.md index 0c2c1de..ee62c99 100644 --- a/docs/fmeserver.md +++ b/docs/fmeserver.md @@ -26,10 +26,10 @@ A command line interface for interacting with FME Server. See available commands * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server * [fmeserver login](fmeserver_login.md) - Save credentials for an FME Server * [fmeserver migration](fmeserver_migration.md) - Returns information on migration tasks using the tasks subcommand. -* [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server +* [fmeserver projects](fmeserver_projects.md) - Lists projects on the FME Server * [fmeserver repositories](fmeserver_repositories.md) - List repositories * [fmeserver restore](fmeserver_restore.md) - Restores the FME Server configuration from an import package -* [fmeserver run](fmeserver_run.md) - Run a workspace on FME Server -* [fmeserver workspaces](fmeserver_workspaces.md) - List workspaces by repository +* [fmeserver run](fmeserver_run.md) - Run a workspace on FME Server. +* [fmeserver workspaces](fmeserver_workspaces.md) - List workspaces. * [Custom Columns output](custom-columns.md) - In depth documentation on using the `custom-columns` output type diff --git a/docs/fmeserver_jobs.md b/docs/fmeserver_jobs.md index 6a0d20a..1d58cb9 100644 --- a/docs/fmeserver_jobs.md +++ b/docs/fmeserver_jobs.md @@ -4,7 +4,7 @@ Lists jobs on FME Server ### Synopsis -Lists jobs on FME Server +Lists running, queued, and/or queued jobs on FME Server. Pass in a job id to get information on a specific job. ``` fmeserver jobs [flags] diff --git a/docs/fmeserver_license_refresh.md b/docs/fmeserver_license_refresh.md index b44cf87..cbdaa7f 100644 --- a/docs/fmeserver_license_refresh.md +++ b/docs/fmeserver_license_refresh.md @@ -35,5 +35,5 @@ fmeserver license refresh [flags] ### SEE ALSO * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server -* [fmeserver license refresh status](fmeserver_license_refresh_status.md) - Check status of license refresh +* [fmeserver license refresh status](fmeserver_license_refresh_status.md) - Check the status of a license refresh request. diff --git a/docs/fmeserver_license_refresh_status.md b/docs/fmeserver_license_refresh_status.md index 757c0bc..0c441b6 100644 --- a/docs/fmeserver_license_refresh_status.md +++ b/docs/fmeserver_license_refresh_status.md @@ -1,6 +1,6 @@ ## fmeserver license refresh status -Check status of license refresh +Check the status of a license refresh request. ### Synopsis diff --git a/docs/fmeserver_license_request.md b/docs/fmeserver_license_request.md index 3a30ad4..3e5d4c4 100644 --- a/docs/fmeserver_license_request.md +++ b/docs/fmeserver_license_request.md @@ -49,5 +49,5 @@ fmeserver license request [flags] ### SEE ALSO * [fmeserver license](fmeserver_license.md) - Interact with licensing an FME Server -* [fmeserver license request status](fmeserver_license_request_status.md) - Check status of license request +* [fmeserver license request status](fmeserver_license_request_status.md) - Check the status of a license request. diff --git a/docs/fmeserver_license_request_status.md b/docs/fmeserver_license_request_status.md index bb03098..aa7d340 100644 --- a/docs/fmeserver_license_request_status.md +++ b/docs/fmeserver_license_request_status.md @@ -1,6 +1,6 @@ ## fmeserver license request status -Check status of license request +Check the status of a license request. ### Synopsis diff --git a/docs/fmeserver_migration.md b/docs/fmeserver_migration.md index 97a0be8..5434514 100644 --- a/docs/fmeserver_migration.md +++ b/docs/fmeserver_migration.md @@ -22,5 +22,5 @@ Returns information on migration tasks using the tasks subcommand. ### SEE ALSO * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -* [fmeserver migration tasks](fmeserver_migration_tasks.md) - Retrieves the records for all migration tasks. +* [fmeserver migration tasks](fmeserver_migration_tasks.md) - Retrieves the records for migration tasks. diff --git a/docs/fmeserver_migration_tasks.md b/docs/fmeserver_migration_tasks.md index b8abee9..22c97d0 100644 --- a/docs/fmeserver_migration_tasks.md +++ b/docs/fmeserver_migration_tasks.md @@ -1,10 +1,10 @@ ## fmeserver migration tasks -Retrieves the records for all migration tasks. +Retrieves the records for migration tasks. ### Synopsis -Retrieves the records for all migration tasks. +Retrieves the records for migration tasks. Get all migration tasks or for a specific task by passing in the id. ``` fmeserver migration tasks [flags] diff --git a/docs/fmeserver_projects.md b/docs/fmeserver_projects.md index 0fb5a37..75b84ca 100644 --- a/docs/fmeserver_projects.md +++ b/docs/fmeserver_projects.md @@ -1,10 +1,10 @@ ## fmeserver projects -Lists all projects on the FME Server +Lists projects on the FME Server ### Synopsis -Lists all projects on the FME Server +Lists projects on the FME Server. Pass in a name to retrieve information on a single project. ``` fmeserver projects [flags] @@ -42,5 +42,5 @@ fmeserver projects [flags] * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. * [fmeserver projects download](fmeserver_projects_download.md) - Downloads an FME Server Project -* [fmeserver projects upload](fmeserver_projects_upload.md) - Imports FME Server Projects from a downloaded import package. +* [fmeserver projects upload](fmeserver_projects_upload.md) - Imports FME Server Projects from a downloaded package. diff --git a/docs/fmeserver_projects_download.md b/docs/fmeserver_projects_download.md index eac0beb..4d66dce 100644 --- a/docs/fmeserver_projects_download.md +++ b/docs/fmeserver_projects_download.md @@ -4,7 +4,7 @@ Downloads an FME Server Project ### Synopsis -Backs up the FME Server configuration to a local file or to a shared resource location on the FME Server. +Downloads an FME Server Project to a local file. Useful for backing up or moving a project to another FME Server. ``` fmeserver projects download [flags] @@ -39,5 +39,5 @@ fmeserver projects download [flags] ### SEE ALSO -* [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server +* [fmeserver projects](fmeserver_projects.md) - Lists projects on the FME Server diff --git a/docs/fmeserver_projects_upload.md b/docs/fmeserver_projects_upload.md index 2bd6c13..ab4494f 100644 --- a/docs/fmeserver_projects_upload.md +++ b/docs/fmeserver_projects_upload.md @@ -1,10 +1,10 @@ ## fmeserver projects upload -Imports FME Server Projects from a downloaded import package. +Imports FME Server Projects from a downloaded package. ### Synopsis -Imports FME Server Projects from a downloaded import package. +Imports FME Server Projects from a downloaded package. Useful for moving a project from one FME Server to another. ``` fmeserver projects upload [flags] @@ -41,5 +41,5 @@ fmeserver projects upload [flags] ### SEE ALSO -* [fmeserver projects](fmeserver_projects.md) - Lists all projects on the FME Server +* [fmeserver projects](fmeserver_projects.md) - Lists projects on the FME Server diff --git a/docs/fmeserver_repositories.md b/docs/fmeserver_repositories.md index d873bc3..e1b112a 100644 --- a/docs/fmeserver_repositories.md +++ b/docs/fmeserver_repositories.md @@ -4,7 +4,7 @@ List repositories ### Synopsis -Lists repositories on the given FME Server. +Lists repositories on the given FME Server. Pass in a name to get information on a specific repository. ``` fmeserver repositories [flags] @@ -52,6 +52,6 @@ fmeserver repositories [flags] ### SEE ALSO * [fmeserver](fmeserver.md) - A command line interface for interacting with FME Server. -* [fmeserver repositories create](fmeserver_repositories_create.md) - Create a repository -* [fmeserver repositories delete](fmeserver_repositories_delete.md) - Delete a repository +* [fmeserver repositories create](fmeserver_repositories_create.md) - Create a new repository. +* [fmeserver repositories delete](fmeserver_repositories_delete.md) - Delete a repository. diff --git a/docs/fmeserver_repositories_create.md b/docs/fmeserver_repositories_create.md index a9c7bb5..82c0561 100644 --- a/docs/fmeserver_repositories_create.md +++ b/docs/fmeserver_repositories_create.md @@ -1,6 +1,6 @@ ## fmeserver repositories create -Create a repository +Create a new repository. ### Synopsis diff --git a/docs/fmeserver_repositories_delete.md b/docs/fmeserver_repositories_delete.md index edfcf69..8cfce64 100644 --- a/docs/fmeserver_repositories_delete.md +++ b/docs/fmeserver_repositories_delete.md @@ -1,6 +1,6 @@ ## fmeserver repositories delete -Delete a repository +Delete a repository. ### Synopsis diff --git a/docs/fmeserver_run.md b/docs/fmeserver_run.md index aa8dbb8..415174e 100644 --- a/docs/fmeserver_run.md +++ b/docs/fmeserver_run.md @@ -1,10 +1,10 @@ ## fmeserver run -Run a workspace on FME Server +Run a workspace on FME Server. ### Synopsis -Run a workspace on FME Server +Run a workspace on FME Server. Examples: # Submit a job asynchronously diff --git a/docs/fmeserver_workspaces.md b/docs/fmeserver_workspaces.md index db40f1b..0a0b71c 100644 --- a/docs/fmeserver_workspaces.md +++ b/docs/fmeserver_workspaces.md @@ -1,10 +1,10 @@ ## fmeserver workspaces -List workspaces by repository +List workspaces. ### Synopsis -Lists workspaces on the given FME Server in the repository. +Lists workspaces that exist on the FME Server. Filter by repository, specify a name to retrieve a specific workspace, or specify a filter string to narrow down by name or title. ``` fmeserver workspaces [flags] @@ -15,6 +15,9 @@ fmeserver workspaces [flags] ``` Examples: + # List all workspaces on the FME Server + fmeserver workspaces + # List all workspaces in Samples repository fmeserver workspaces --repository Samples @@ -34,7 +37,7 @@ fmeserver workspaces [flags] ### Options ``` - --filter-string string Specify the output type. Should be one of table, json, or custom-columns. Only usable with V4 API. + --filter-string string If specified, only workspaces with a matching name or title will be returned. Only usable with V4 API. -h, --help help for workspaces --name string If specified, get details about a specific workspace --no-headers Don't print column headers