rclone/docs/content/commands/rclone_gendocs.md

---
date: 2019-08-26T15:19:45+01:00
title: "rclone gendocs"
slug: rclone_gendocs
url: /commands/rclone_gendocs/
---
## rclone gendocs

Output markdown docs for rclone to the directory supplied.

### Synopsis


This produces markdown docs for the rclone commands to the directory
supplied.  These are in a format suitable for hugo to render into the
rclone.org website.

```
rclone gendocs output_directory [flags]
```

### Options

```
  -h, --help   help for gendocs
```

See the [global flags page](/flags/) for global options not listed here.

### SEE ALSO

* [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md 2016-08-04 04:36:28 +08:00			`---`
Version v1.49.0 2019-08-26 22:25:20 +08:00			`date: 2019-08-26T15:19:45+01:00`
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md 2016-08-04 04:36:28 +08:00			`title: "rclone gendocs"`
			`slug: rclone_gendocs`
			`url: /commands/rclone_gendocs/`
			`---`
			`## rclone gendocs`

			`Output markdown docs for rclone to the directory supplied.`

			`### Synopsis`


			`This produces markdown docs for the rclone commands to the directory`
			`supplied. These are in a format suitable for hugo to render into the`
			`rclone.org website.`

			```
Add ftp.md to docs builder and update docs 2017-06-16 03:12:26 +08:00			`rclone gendocs output_directory [flags]`
			```

			`### Options`

			```
			`-h, --help help for gendocs`
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md 2016-08-04 04:36:28 +08:00			```

docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273 2019-06-20 23:18:02 +08:00			`See the [global flags page](/flags/) for global options not listed here.`

Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md 2016-08-04 04:36:28 +08:00			`### SEE ALSO`

Version v1.44 2018-10-15 18:03:08 +08:00			`* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.`
Version v1.40 2018-03-19 18:06:13 +08:00