Skip to content
This repository was archived by the owner on Dec 22, 2025. It is now read-only.

Commit 966526d

Browse files
authored
Updated steal help output in readme (#126)
1 parent b4a5096 commit 966526d

File tree

2 files changed

+27
-13
lines changed

2 files changed

+27
-13
lines changed

README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ Klepto is a tool that copies and anonymises data from other sources.
2626
- [Matchers](#matchers)
2727
- [Anonymise](#anonymise)
2828
- [Relationships](#relationships)
29-
- [Examples](#examples)
3029
- [Contributing](#contributing)
3130
- [License](#licence)
3231

@@ -111,11 +110,34 @@ Behind the scenes Klepto will establishes the connection with the source and tar
111110

112111
<a name="steal-options"></a>
113112
## Steal Options
114-
The available options can be seen by running `klepto steal -h`
113+
Available options can be seen by running `klepto steal --help`
115114

116-
<p align="left">
117-
<img src="./klepto-steal-help.png" alt="Klepto Steal Help" title="Klepto Steal Help">
118-
</p>
115+
```
116+
❯ klepto steal --help
117+
Steals and anonymises databases
118+
119+
Usage:
120+
klepto steal [flags]
121+
122+
Flags:
123+
--concurrency int Sets the amount of dumps to be performed concurrently (default 12)
124+
-c, --config string Path to config file (default ".klepto.toml")
125+
-f, --from string Database dsn to steal from (default "mysql://root:root@tcp(localhost:3306)/klepto")
126+
-h, --help help for steal
127+
--read-conn-lifetime duration Sets the maximum amount of time a connection may be reused on the read database
128+
--read-max-conns int Sets the maximum number of open connections to the read database (default 5)
129+
--read-max-idle-conns int Sets the maximum number of connections in the idle connection pool for the read database
130+
--read-timeout duration Sets the timeout for read operations (default 5m0s)
131+
-t, --to string Database to output to (default writes to stdOut) (default "os://stdout/")
132+
--to-rds If the output server is an AWS RDS server
133+
--write-conn-lifetime duration Sets the maximum amount of time a connection may be reused on the write database
134+
--write-max-conns int Sets the maximum number of open connections to the write database (default 5)
135+
--write-max-idle-conns int Sets the maximum number of connections in the idle connection pool for the write database
136+
--write-timeout duration Sets the timeout for write operations (default 30s)
137+
138+
Global Flags:
139+
-v, --verbose Make the operation more talkative
140+
```
119141

120142
We recommend to always set the following parameters:
121143
- `concurrency` to alleviate the pressure over both the source and target databases.
@@ -237,12 +259,6 @@ To dump the latest 100 users with their orders:
237259
```
238260

239261

240-
241-
<a name="examples"></a>
242-
## Examples
243-
244-
Example configuration files for intfood and the ordering tool can be found on [Klepto Examples][klepto-examples-confluence] on Confluence.
245-
246262
<a name="contributing"></a>
247263
## Contributing
248264

@@ -254,7 +270,5 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
254270
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
255271

256272

257-
258273
[pg_dump-docs]: https://www.postgresql.org/docs/10/static/app-pgdump.html "pg_dump docs"
259274
[klepto-releases]: https://github.com/hellofresh/klepto/releases "Klepto releases page"
260-
[klepto-examples-confluence]: https://hellofresh.atlassian.net/wiki/spaces/PLAT/pages/204505400/Klepto+Examples "Klepto examples confluence"

klepto-steal-help.png

-301 KB
Binary file not shown.

0 commit comments

Comments
 (0)