Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
profclems committed Jul 14, 2023
1 parent b7c3ed4 commit 025b979
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/compozify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## compozify

compozify is a tool mainly for converting docker run commands to docker compose files

### Options

```
-h, --help help for compozify
-v, --verbose verbose output
```

### SEE ALSO

* [compozify convert](compozify_convert.md) - convert docker run command to docker compose file

44 changes: 44 additions & 0 deletions docs/compozify_convert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## compozify convert

convert docker run command to docker compose file

```
compozify convert [flags] DOCKER_RUN_COMMAND
```

### Examples

```
# convert and write to stdout
$ compozify convert "docker run -i -t --rm alpine"
# write to file
$ compozify convert -w "docker run -i -t --rm alpine"
# write to file with custom name
$ compozify convert -w -o docker-compose.yml "docker run -i -t --rm alpine"
# alternative usage specifying beginning of docker run command
$ compozify convert -w -- docker run -i -t --rm alpine
```

### Options

```
-h, --help help for convert
-o, --out string output file path (default "compose.yml")
-w, --write write to file
```

### Options inherited from parent commands

```
-v, --verbose verbose output
```

### SEE ALSO

* [compozify](compozify.md) - compozify is a tool mainly for converting docker run commands to docker compose files

0 comments on commit 025b979

Please sign in to comment.