Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixed walk-directories help text description

Signed-off-by: Greg Arnette <[email protected]>
  • Loading branch information
gregarnette committed May 30, 2024
1 parent b2ae68e commit d8e6fc1
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,31 @@ docker run --rm -e CLOUDTRUTH_API_KEY="myverysecureS3CR3T!!" -v ${PWD}/files:/ap

# Command help

**Automatic mode processes a directory tree and creates parameters, values and templates.**
**Automatic mode processes a directory tree and creates parameters, values, and templates.**
```
walk-directories --help
```

This command walks a directory, constructs templates and config data, and uploads to CloudTruth. It is an interactive version of the process_configs and create_data commands. As files are walked, the user will be prompted for project and environment names.

Options:

--config-dirs - Full path to the directory to walk and locate configs

-t, --file-types - Type of file to process. Must be one of 'dotenv', 'json', 'tf', 'tfvars', 'yaml'

--exclude-dirs - Directory to exclude from walking. Can be specified multiple times

--create-hierarchy - If specified, project hierarchy will be created based on the directory hierarchy

--parse-descriptions - Detect comments in the input file and use them for parameter descriptions

-k - Ignore SSL certificate verification

-c - Create missing projects and environments

-u - Upsert values

**Manual mode step 1 - Find and convert**
```
process-configs --help
Expand Down

0 comments on commit d8e6fc1

Please sign in to comment.