Skip to content

Commit 4b3c7e4

Browse files
author
Keyfactor
committed
Update generated README
1 parent b360b0d commit 4b3c7e4

File tree

1 file changed

+15
-60
lines changed

1 file changed

+15
-60
lines changed

README.md

Lines changed: 15 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,10 @@
1+
12
# Keyfactor Command Utility (kfutil)
23

34
`kfutil` is a go-lang CLI wrapper for Keyfactor Command API. It also includes other utility/helper functions around automating common Keyfactor Command operations.
45

56
#### Integration status: Production - Ready for use in production environments.
67

7-
<!-- toc -->
8-
9-
- [About the Keyfactor API Client](#about-the-keyfactor-api-client)
10-
- [Support for Keyfactor Command Utility (kfutil)](#support-for-keyfactor-command-utility-kfutil)
11-
- [Quickstart](#quickstart)
12-
* [Linux/MacOS](#linuxmacos)
13-
+ [Prerequisites:](#prerequisites)
14-
+ [Installation:](#installation)
15-
* [Windows](#windows)
16-
+ [Prerequisites:](#prerequisites-1)
17-
+ [Installation:](#installation-1)
18-
- [Environmental Variables](#environmental-variables)
19-
* [Linux/MacOS:](#linuxmacos)
20-
* [Windows Powershell:](#windows-powershell)
21-
- [Authentication Providers](#authentication-providers)
22-
- [Commands](#commands)
23-
* [Login](#login)
24-
* [Logout](#logout)
25-
- [Commands](#commands-1)
26-
* [Bulk operations](#bulk-operations)
27-
+ [Bulk create cert stores](#bulk-create-cert-stores)
28-
+ [Bulk create cert store types](#bulk-create-cert-store-types)
29-
* [Root of Trust](#root-of-trust)
30-
+ [Quickstart](#quickstart-1)
31-
+ [Generate Certificate List Template](#generate-certificate-list-template)
32-
+ [Generate Certificate Store List Template](#generate-certificate-store-list-template)
33-
+ [Run Root of Trust Audit](#run-root-of-trust-audit)
34-
+ [Run Root of Trust Reconcile](#run-root-of-trust-reconcile)
35-
* [Certificate Store Inventory](#certificate-store-inventory)
36-
+ [Show the inventory of a certificate store](#show-the-inventory-of-a-certificate-store)
37-
+ [Add certificates to certificate stores](#add-certificates-to-certificate-stores)
38-
+ [Remove certificates from certificate stores](#remove-certificates-from-certificate-stores)
39-
- [Development](#development)
40-
* [Adding a new command](#adding-a-new-command)
41-
42-
<!-- tocstop -->
43-
448
## About the Keyfactor API Client
459

4610
This API client allows for programmatic management of Keyfactor resources.
@@ -49,7 +13,14 @@ This API client allows for programmatic management of Keyfactor resources.
4913

5014
Keyfactor Command Utility (kfutil) is open source and supported on best effort level for this tool/library/client. This means customers can report Bugs, Feature Requests, Documentation amendment or questions as well as requests for customer information required for setup that needs Keyfactor access to obtain. Such requests do not follow normal SLA commitments for response or resolution. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com/
5115

52-
[!NOTE] To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
16+
###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
17+
18+
---
19+
20+
21+
---
22+
23+
5324

5425
## Quickstart
5526

@@ -170,45 +141,29 @@ kfutil logout
170141

171142
#### Bulk create cert stores
172143

173-
For full documentation, see [stores import](docs/kfutil_stores_import.md). For a full user-interactive guide, see the
174-
[stores bulk operations examples](examples/cert_stores/bulk_operations/README.md).
144+
For full documentation, see [stores import](docs/kfutil_stores_import.md).
175145

176146
This will attempt to process a CSV input file of certificate stores to create. The template can be generated by
177147
running: `kfutil stores import generate-template` command.
178148

179149
```bash
180-
kfutil stores import csv --file <file name to import>
150+
kfutil stores import create --file <file name to import> --store-type-id <store type id> --store-type-name <store type name> --results-path <filepath for results> --dry-run <check fields only> [flags]
181151
```
182152

183153
```bash
184-
kfutil stores import --help
185-
Tools for generating import templates and importing certificate stores
154+
kfutil stores import --help
155+
Tool for generating import templates and importing certificate stores
186156
187157
Usage:
188158
kfutil stores import [command]
189159
190160
Available Commands:
191-
csv Create certificate stores from CSV file.
161+
create Create certificate stores
192162
generate-template For generating a CSV template with headers for bulk store creation.
193163
194164
Flags:
195165
-h, --help help for import
196166
197-
Global Flags:
198-
--api-path string API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
199-
--auth-provider-profile string The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
200-
--auth-provider-type string Provider type choices: (azid)
201-
--config string Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
202-
--debug Enable debugFlag logging.
203-
--domain string Domain to use for authenticating to Keyfactor Command.
204-
--exp Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
205-
--format text How to format the CLI output. Currently only text is supported. (default "text")
206-
--hostname string Hostname to use for authenticating to Keyfactor Command.
207-
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
208-
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
209-
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
210-
--username string Username to use for authenticating to Keyfactor Command.
211-
212167
Use "kfutil stores import [command] --help" for more information about a command.
213168
```
214169

@@ -251,7 +206,7 @@ For full documentation, see [stores rot](docs/kfutil_stores_rot.md).
251206
The root of trust (rot) utility is a tool that allows you to bulk manage Keyfactor certificate stores and ensure that a
252207
set of defined certificates are present in each store that meets a certain set of criteria or no criteria at all.
253208
254-
#### Quickstart
209+
#### Root of Trust Quickstart
255210
256211
```bash
257212
echo "Generating cert template file certs_template.csv"

0 commit comments

Comments
 (0)