Skip to content

Commit 86b9d09

Browse files
committed
feat(docs): add command line options and usage instructions for CipherStash Proxy
1 parent a43c482 commit 86b9d09

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

docs/reference/index.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,87 @@ As a convenience for production deployments, with the below environment variable
258258
CS_DATABASE__INSTALL_AWS_RDS_CERT_BUNDLE="true"
259259
```
260260

261+
## Command line options
262+
263+
264+
265+
## Command line interface
266+
267+
The CipherStash Proxy accepts command line arguments.
268+
For example, the upstream database can be specified via command line arguments.
269+
Useful for local dev and testing.
270+
271+
### Usage
272+
273+
```bash
274+
cipherstash-proxy [OPTIONS] [DBNAME] [COMMAND]
275+
```
276+
277+
### Commands
278+
279+
- **encrypt**
280+
Encrypt one or more columns in a table. This command requires a running and properly configured CipherStash Proxy instance.
281+
282+
- **help**
283+
Print the help message or detailed information for the specified subcommand(s).
284+
285+
### Arguments
286+
287+
- **DBNAME**
288+
289+
Optional name of the database to connect to. If not specified, the tool will use the environment variables or configuration file settings.
290+
291+
Default value: none
292+
293+
- **-H, --db-host <DB_HOST>**
294+
295+
Optional database host. This value will default to the one defined in your environment or configuration file if not provided.
296+
297+
Default value: `127.0.0.1`
298+
299+
- **-u, --db-user <DB_USER>**
300+
301+
Optional database user. This value will default to the one defined in your environment or configuration file if not provided.
302+
303+
Default value: `postgres`
304+
305+
- **-p, --config-file-path <CONFIG_FILE_PATH>**
306+
307+
Specifies an optional path to a CipherStash Proxy configuration file.
308+
If provided, the application attempts to load configuration settings from this file.
309+
However, environment variables can be used instead of the file or to override any values defined within it.
310+
311+
Default Value: `cipherstash-proxy.toml`
312+
313+
Note:
314+
The application will look for "cipherstash-proxy.toml" by default if no other file path is specified.
315+
316+
- **-l, --log-level <LOG_LEVEL>**
317+
318+
Sets an optional log level for the application, which controls the verbosity of the logging output.
319+
This can be particularly useful for adjusting the level of detail in application logs
320+
to suit different environments or debugging needs.
321+
322+
Default Value: `info`
323+
324+
Environment Variable: `CS_LOG__LEVEL`
325+
326+
Possible Values: `error`, `warn`, `info`, `debug`, `trace`
327+
328+
- **-f, --log-format <LOG_FORMAT>**
329+
330+
Specifies an optional log format for the output logs.
331+
The default log format is "pretty" when the application detects that it is running in a terminal session,
332+
otherwise it defaults to "structured" for non-interactive environments.
333+
The setting can be overridden by the corresponding environment variable.
334+
335+
Default Value: `pretty` (if running in a terminal session), otherwise `structured`
336+
337+
Environment Variable: `CS_LOG__FORMAT`
338+
339+
Possible Values: `pretty`, `structured`, `text`
340+
341+
261342
## Multitenant operation
262343

263344
CipherStash Proxy supports multitenant applications using ZeroKMS keysets to provide strong cryptographic separation between tenants.

0 commit comments

Comments
 (0)