@@ -3,6 +3,9 @@ title: Flamingock CLI
33sidebar_position : 999
44---
55
6+ import Tabs from '@theme/Tabs ';
7+ import TabItem from '@theme/TabItem ';
8+
69# Flamingock CLI
710
811Command-line tool for audit management and maintenance operations.
@@ -35,8 +38,10 @@ chmod +x flamingock
3538
3639### Configuration
3740
38- Create a ` flamingock.yaml ` configuration file in your working directory :
41+ Modify the ` flamingock-cli.yml ` configuration file in flamingock-cli/bin directory according to your audit store setup :
3942
43+ <Tabs groupId =" cli_config " >
44+ <TabItem value =" mongodb " label =" MongoDB " default >
4045#### MongoDB configuration
4146``` yaml
4247serviceIdentifier : my-service # Optional, defaults to "flamingock-cli"
@@ -50,10 +55,11 @@ audit:
5055 # username: admin
5156 # password: secret
5257```
53-
58+ </TabItem >
59+ <TabItem value =" dynamodb " label =" Amazon DynamoDB " >
5460#### DynamoDB configuration
5561``` yaml
56- serviceIdentifier : my-service
62+ serviceIdentifier : my-service # Optional, defaults to "flamingock-cli"
5763audit :
5864 dynamodb :
5965 region : us-east-1
@@ -62,6 +68,20 @@ audit:
6268 # accessKey: local
6369 # secretKey: local
6470```
71+ </TabItem >
72+ <TabItem value =" couchbase " label =" Couchabse " >
73+ #### Couchbase configuration
74+ ``` yaml
75+ serviceIdentifier : my-service # Optional, defaults to "flamingock-cli"
76+ audit :
77+ couchbase :
78+ endpoint : " couchbase://localhost:12110"
79+ username : " your-username"
80+ password : " your-password"
81+ bucket-name : " my-app"
82+ ` ` `
83+ </TabItem>
84+ </Tabs>
6585
6686You can specify a custom configuration file using the ` -c` or `--config` option:
6787` ` ` bash
@@ -145,7 +165,7 @@ For detailed workflows on issue resolution, see [Issue resolution](../safety-and
145165flamingock [global-options] <command> [command-options]
146166` ` `
147167
148- - ` -c, --config <file> ` - Configuration file path (default: ` flamingock ` )
168+ - `-c, --config <file>` - Configuration file path (default : ` bin/ flamingock-cli.yml ` )
149169- ` --verbose` - Enable verbose logging
150170- ` --debug` - Enable debug logging
151171- ` --trace` - Enable trace logging (most detailed level)
0 commit comments