> ## Documentation Index
> Fetch the complete documentation index at: https://www.jetify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# devbox generate readme

> Generate a markdown readme file for this project. You must specify a name for the Readme file when running the command:

```bash theme={null}
devbox generate readme [filename] [flags]
```

## Options[​](#options "Direct link to Options")

| Option                | Description                                            |
| --------------------- | ------------------------------------------------------ |
| `-c, --config string` | path to directory containing a devbox.json config file |
| `-h, --help`          | help for readme                                        |
| `-q, --quiet`         | Quiet mode: Suppresses logs.                           |

## SEE ALSO[​](#see-also "Direct link to SEE ALSO")

* [devbox generate](/docs/devbox/cli-reference/devbox-generate/) - Generate supporting files for
  your project

[Edit this page](https://github.com/jetify-com/docs/tree/main/docs/devbox/cli-reference/devbox-generate-readme/index.mdx)