docs/edge/engine/reference/commandline
gbarr01 cb157b3318 Update engine CLI docs, stubs, and TOC 2018-03-22 16:52:53 -07:00
..
README.md Move /engine/installation to /install (#5651) 2018-01-26 10:29:14 -08:00
attach.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
build.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
checkpoint.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
checkpoint_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
checkpoint_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
checkpoint_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
commit.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
config.md Add docker config to edge 2017-12-15 14:58:06 -08:00
config_create.md Update CLI reference files and TOC 2018-01-02 17:13:00 -08:00
config_inspect.md Update CLI reference files and TOC 2018-01-02 17:13:00 -08:00
config_ls.md Update CLI reference files and TOC 2018-01-02 17:13:00 -08:00
config_rm.md Update CLI reference files and TOC 2018-01-02 17:13:00 -08:00
container.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_attach.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_commit.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_cp.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_diff.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_exec.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_export.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_kill.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_logs.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_pause.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_port.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_prune.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_rename.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_restart.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_run.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_start.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_stats.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_stop.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_top.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_unpause.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_update.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
container_wait.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
cp.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
deploy.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
diff.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
docker.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
events.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
exec.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
export.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
history.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_build.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_history.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_import.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_load.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_prune.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_pull.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_push.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_save.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
image_tag.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
images.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
import.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
info.md Add info about warnings in docker info (#5048) 2017-10-20 09:48:10 -07:00
inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
kill.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
load.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
login.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
logout.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
logs.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
manifest.md Update engine CLI docs, stubs, and TOC 2018-02-08 13:54:12 -08:00
manifest_annotate.md Update engine CLI docs, stubs, and TOC 2018-02-08 13:54:12 -08:00
manifest_create.md Update engine CLI docs, stubs, and TOC 2018-02-08 13:54:12 -08:00
manifest_inspect.md Update engine CLI docs, stubs, and TOC 2018-02-08 13:54:12 -08:00
manifest_push.md Update engine CLI docs, stubs, and TOC 2018-02-08 13:54:12 -08:00
network.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_connect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_disconnect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_prune.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
network_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_demote.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_promote.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_ps.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
node_update.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
pause.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_disable.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_enable.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_install.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_push.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_set.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
plugin_upgrade.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
port.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
ps.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
pull.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
push.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
rename.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
restart.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
rmi.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
run.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
save.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
search.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
secret.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
secret_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
secret_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
secret_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
secret_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_logs.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_ps.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_rollback.md Update YAML files for CLI refs 2017-09-26 20:49:43 -07:00
service_scale.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
service_update.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stack.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stack_deploy.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stack_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stack_ps.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stack_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stack_services.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
start.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stats.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
stop.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_ca.md Update CLI reference files and TOC 2018-01-02 17:13:00 -08:00
swarm_init.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_join-token.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_join.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_leave.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_unlock-key.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_unlock.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
swarm_update.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
system.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
system_df.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
system_events.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
system_info.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
system_prune.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
tag.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
top.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
trust.md Add 17.10 CLI ref 2017-10-17 21:34:07 -07:00
trust_inspect.md Update CLI reference files and TOC 2018-01-02 17:13:00 -08:00
trust_key.md Updated CLI reference files 2017-11-20 14:25:56 -08:00
trust_key_generate.md Updated CLI reference files 2017-11-20 14:25:56 -08:00
trust_key_load.md Updated CLI reference files 2017-11-20 14:25:56 -08:00
trust_revoke.md Add 17.10 CLI ref 2017-10-17 21:34:07 -07:00
trust_sign.md Add 17.10 CLI ref 2017-10-17 21:34:07 -07:00
trust_signer.md Updated CLI reference files 2017-11-20 14:25:56 -08:00
trust_signer_add.md Updated CLI reference files 2017-11-20 14:25:56 -08:00
trust_signer_remove.md Updated CLI reference files 2017-11-20 14:25:56 -08:00
unpause.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
update.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
version.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
volume.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
volume_create.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
volume_inspect.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
volume_ls.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
volume_prune.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
volume_rm.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00
wait.md Fix source link in cli reference docs (#4374) 2017-08-28 13:39:11 -07:00

README.md

About these files

The files in this directory are stub files which include the file /_includes/cli.md, which parses YAML files generated from the docker/docker repository. The YAML files are parsed into output files like /engine/reference/commandline/build/.

How the output is generated

The output files are composed from two sources:

  • The Description and Usage sections comes directly from the CLI source code in that repository.

  • The Extended Description and Examples sections are pulled into the YAML from the files in https://github.com/moby/moby/tree/master/docs/reference/commandline Specifically, the Markdown inside the ## Description and ## Examples headings are parsed. Submit corrections to the text in that repository.

Updating the YAML files

The process for generating the YAML files is still in flux. Check with @thajestah or @frenchben. Be sure to generate the YAML files with the correct branch of docker/docker checked out (probably not master).

After generating the YAML files, replace the YAML files in https://github.com/docker/docker.github.io/tree/master/_data/engine-cli with the newly-generated files. Submit a pull request.