Skip to content

Commit

Permalink
Update generated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Keyfactor committed Mar 6, 2024
1 parent b360b0d commit 4b3c7e4
Showing 1 changed file with 15 additions and 60 deletions.
75 changes: 15 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,10 @@

# Keyfactor Command Utility (kfutil)

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

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

<!-- toc -->

- [About the Keyfactor API Client](#about-the-keyfactor-api-client)
- [Support for Keyfactor Command Utility (kfutil)](#support-for-keyfactor-command-utility-kfutil)
- [Quickstart](#quickstart)
* [Linux/MacOS](#linuxmacos)
+ [Prerequisites:](#prerequisites)
+ [Installation:](#installation)
* [Windows](#windows)
+ [Prerequisites:](#prerequisites-1)
+ [Installation:](#installation-1)
- [Environmental Variables](#environmental-variables)
* [Linux/MacOS:](#linuxmacos)
* [Windows Powershell:](#windows-powershell)
- [Authentication Providers](#authentication-providers)
- [Commands](#commands)
* [Login](#login)
* [Logout](#logout)
- [Commands](#commands-1)
* [Bulk operations](#bulk-operations)
+ [Bulk create cert stores](#bulk-create-cert-stores)
+ [Bulk create cert store types](#bulk-create-cert-store-types)
* [Root of Trust](#root-of-trust)
+ [Quickstart](#quickstart-1)
+ [Generate Certificate List Template](#generate-certificate-list-template)
+ [Generate Certificate Store List Template](#generate-certificate-store-list-template)
+ [Run Root of Trust Audit](#run-root-of-trust-audit)
+ [Run Root of Trust Reconcile](#run-root-of-trust-reconcile)
* [Certificate Store Inventory](#certificate-store-inventory)
+ [Show the inventory of a certificate store](#show-the-inventory-of-a-certificate-store)
+ [Add certificates to certificate stores](#add-certificates-to-certificate-stores)
+ [Remove certificates from certificate stores](#remove-certificates-from-certificate-stores)
- [Development](#development)
* [Adding a new command](#adding-a-new-command)

<!-- tocstop -->

## About the Keyfactor API Client

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

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/

[!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.
###### 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.

---


---



## Quickstart

Expand Down Expand Up @@ -170,45 +141,29 @@ kfutil logout

#### Bulk create cert stores

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

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

```bash
kfutil stores import csv --file <file name to import>
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]
```

```bash
kfutil stores import --help
Tools for generating import templates and importing certificate stores
kfutil stores import --help
Tool for generating import templates and importing certificate stores
Usage:
kfutil stores import [command]
Available Commands:
csv Create certificate stores from CSV file.
create Create certificate stores
generate-template For generating a CSV template with headers for bulk store creation.
Flags:
-h, --help help for import
Global Flags:
--api-path string API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
--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")
--auth-provider-type string Provider type choices: (azid)
--config string Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
--debug Enable debugFlag logging.
--domain string Domain to use for authenticating to Keyfactor Command.
--exp Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
--format text How to format the CLI output. Currently only text is supported. (default "text")
--hostname string Hostname to use for authenticating to Keyfactor Command.
--no-prompt Do not prompt for any user input and assume defaults or environmental variables are set.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--username string Username to use for authenticating to Keyfactor Command.
Use "kfutil stores import [command] --help" for more information about a command.
```

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

0 comments on commit 4b3c7e4

Please sign in to comment.