Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
garnold54 committed Mar 29, 2024
1 parent 5bd1715 commit 8ad248f
Show file tree
Hide file tree
Showing 6 changed files with 171 additions and 23 deletions.
4 changes: 2 additions & 2 deletions docs/fmeflow_deploymentparameters_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ fmeflow deploymentparameters delete [flags]

```
-h, --help help for delete
--name string Name of the repository to create.
-y, --no-prompt Description of the new repository.
--name string Name of the Deployment Parameter to delete.
-y, --no-prompt Do not prompt for confirmation.
```

### Options inherited from parent commands
Expand Down
28 changes: 22 additions & 6 deletions docs/fmeflow_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,30 @@ fmeflow projects [flags]
# List all projects owned by the user admin
fmeflow projects --owner admin
# Get a single project by name
fmeflow projects --name "My Project"
# Get a single project by id
fmeflow projects --id a64297e7-a119-4e10-ac37-5d0bba12194b
# Get a single project by name and output as JSON
fmeflow projects --name "My Project" --output json
# Get all projects and output as custom columns
fmeflow projects --output=custom-columns=ID:.id,NAME:.name
```

### 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.
--api-version string The api version to use when contacting FME Server. Must be one of v3 or v4
-h, --help help for projects
--id string Return a single project with the given id. (v4 only)
--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
Expand All @@ -41,6 +55,8 @@ fmeflow projects [flags]
### SEE ALSO

* [fmeflow](fmeflow.md) - A command line interface for interacting with FME Server.
* [fmeflow projects delete](fmeflow_projects_delete.md) - Deletes an FME Flow Project
* [fmeflow projects download](fmeflow_projects_download.md) - Downloads an FME Server Project
* [fmeflow projects upload](fmeflow_projects_upload.md) - Imports FME Server Projects from a downloaded package.
* [fmeflow projects items](fmeflow_projects_items.md) - Lists the items for the specified project
* [fmeflow projects upload](fmeflow_projects_upload.md) - Imports FME Flow Projects from a downloaded package.

51 changes: 51 additions & 0 deletions docs/fmeflow_projects_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## fmeflow projects delete

Deletes an FME Flow Project

### Synopsis

Deletes an FME Flow Project from the FME Server. Can optionally also delete the project contents and its dependencies.

```
fmeflow projects delete [flags]
```

### Examples

```
# Delete a project by id
fmeflow projects delete --id 123
# Delete a project by name
fmeflow projects delete --name "My Project"
# Delete a project by name and all its contents
fmeflow projects delete --name "My Project" --all
# Delete a project by name and all its contents and dependencies
fmeflow projects delete --name "My Project" --all --dependencies
```

### Options

```
--all Delete the project and its contents
--dependencies Delete the project and its contents and dependencies. Can only be specified if all is also specified
-h, --help help for delete
--id string The id of the project to delete. Either id or name must be specified
--name string The name of the project to delete. Either id or name must be specified
-y, --no-prompt Do not prompt for confirmation.
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/.fmeflow-cli.yaml)
--json Output JSON
```

### SEE ALSO

* [fmeflow projects](fmeflow_projects.md) - Lists projects on the FME Server

10 changes: 6 additions & 4 deletions docs/fmeflow_projects_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ fmeflow projects download [flags]
### 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.
--exclude-selectable-items Excludes all selectable item in this package. Default is false.
--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
--id string ID of the project to download.
--name string Name of the project to download.
```

### Options inherited from parent commands
Expand Down
57 changes: 57 additions & 0 deletions docs/fmeflow_projects_items.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## fmeflow projects items

Lists the items for the specified project

### Synopsis

Lists the items contained in the specified project.

```
fmeflow projects items [flags]
```

### Examples

```
# Get all items for a project via id
fmeflow projects items --id a64297e7-a119-4e10-ac37-5d0bba12194b
# Get all items for a project via name
fmeflow projects items --name test_project
# Get items with type workspace for a project via name
fmeflow projects items --name test_project --type workspace
# Get all items for a project via name without dependencies
fmeflow projects items --name test_project --include-dependencies=false
# Get all items for a project via name with a filter on name
fmeflow projects items --name test_project --filter-string "test_name" --filter-properties "name"
```

### Options

```
--filter-property stringArray Property to filter by. Should be one of "name" or "owner". Can only be set if filter-string is also set
--filter-string string String to filter items by
-h, --help help for items
--id string Id of project to get items for
--include-dependencies Include dependencies in the output (default true)
--name string Name of project to get items for
--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")
--type stringArray Type of items to get
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/.fmeflow-cli.yaml)
--json Output JSON
```

### SEE ALSO

* [fmeflow projects](fmeflow_projects.md) - Lists projects on the FME Server

44 changes: 33 additions & 11 deletions docs/fmeflow_projects_upload.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
## fmeflow projects upload

Imports FME Server Projects from a downloaded package.
Imports FME Flow Projects from a downloaded package.

### Synopsis

Imports FME Server Projects from a downloaded package. Useful for moving a project from one FME Server to another.
Imports FME Flow Projects from a downloaded package. The upload happens in two steps. The package is uploaded to the server, a preview is generated that contains the list of items, and then the import is run. This command can be run using a few different modes.
- Using the --get-selectable flag will just generate the preview and output the selectable items in the package and then delete the import
- Using the --quick flag will skip the preview and import everything in the package by default.
- Using the --interactive flag will prompt the user to select items to import from the list of selectable items if any exist
- Using the --selected-items flag will import only the items specified. The default is to import all items in the package.

```
fmeflow projects upload [flags]
Expand All @@ -14,22 +18,40 @@ fmeflow projects upload [flags]

```
# Restore from a backup in a local file
# Upload a project and import all selectable items if any exist
fmeflow projects upload --file ProjectPackage.fsproject
# Restore from a backup in a local file using UPDATE mode
fmeflow projects upload --file ProjectPackage.fsproject --import-mode UPDATE
# Upload a project without overwriting existing items
fmeflow projects upload --file ProjectPackage.fsproject --overwrite=false
# Upload a project and perform a quick import
fmeflow projects upload --file ProjectPackage.fsproject --quick
# Upload a project and be prompted for which items to import of the selectable items
fmeflow projects upload --file ProjectPackage.fsproject --interactive
# Upload a project and get the list of selectable items
fmeflow projects upload --file ProjectPackage.fsproject --get-selectable
# Upload a project and import only the specified selectable items
fme projects upload --file ProjectPackage.fsproject --selected-items="mysqldb:connection,slack con:connector"
```

### 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.
--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.
--failure-topic string Topic to notify on failure of the backup. (default "MIGRATION_ASYNC_JOB_FAILURE")
-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.
--get-selectable Output the selectable items in the import package.
-h, --help help for upload
--interactive Prompt interactively for the selectable items to import (if any exist).
--overwrite If specified, the items in the project will overwrite existing items. (default true)
--pause-notifications Disable notifications for the duration of the restore. (default true)
--quick Import everything in the package by default.
--selected-items string The items to import. Set to "all" to import all items, and "none" to omit selectable items. Otherwise, this should be a comma separated list of item ids type pairs separated by a colon. e.g. a:b,c:d (default "all")
--success-topic string Topic to notify on success of the backup. (default "MIGRATION_ASYNC_JOB_SUCCESS")
--wait Wait for import to complete. Set to false to return immediately after the import is started. (default true)
```

### Options inherited from parent commands
Expand Down

0 comments on commit 8ad248f

Please sign in to comment.