Docker-Docs/engine/reference/commandline
YuCheng Hu e8587dc33f init submit all files 2020-11-18 13:32:27 -05:00
..
README.md init submit all files 2020-11-18 13:32:27 -05:00
app.md init submit all files 2020-11-18 13:32:27 -05:00
app_bundle.md init submit all files 2020-11-18 13:32:27 -05:00
app_completion.md init submit all files 2020-11-18 13:32:27 -05:00
app_init.md init submit all files 2020-11-18 13:32:27 -05:00
app_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
app_install.md init submit all files 2020-11-18 13:32:27 -05:00
app_list.md init submit all files 2020-11-18 13:32:27 -05:00
app_merge.md init submit all files 2020-11-18 13:32:27 -05:00
app_pull.md init submit all files 2020-11-18 13:32:27 -05:00
app_push.md init submit all files 2020-11-18 13:32:27 -05:00
app_render.md init submit all files 2020-11-18 13:32:27 -05:00
app_split.md init submit all files 2020-11-18 13:32:27 -05:00
app_status.md init submit all files 2020-11-18 13:32:27 -05:00
app_uninstall.md init submit all files 2020-11-18 13:32:27 -05:00
app_upgrade.md init submit all files 2020-11-18 13:32:27 -05:00
app_validate.md init submit all files 2020-11-18 13:32:27 -05:00
app_version.md init submit all files 2020-11-18 13:32:27 -05:00
attach.md init submit all files 2020-11-18 13:32:27 -05:00
build.md init submit all files 2020-11-18 13:32:27 -05:00
builder.md init submit all files 2020-11-18 13:32:27 -05:00
builder_build.md init submit all files 2020-11-18 13:32:27 -05:00
builder_prune.md init submit all files 2020-11-18 13:32:27 -05:00
buildx.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_bake.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_build.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_create.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_du.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_imagetools.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_imagetools_create.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_imagetools_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_ls.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_prune.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_rm.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_stop.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_use.md init submit all files 2020-11-18 13:32:27 -05:00
buildx_version.md init submit all files 2020-11-18 13:32:27 -05:00
checkpoint.md init submit all files 2020-11-18 13:32:27 -05:00
checkpoint_create.md init submit all files 2020-11-18 13:32:27 -05:00
checkpoint_ls.md init submit all files 2020-11-18 13:32:27 -05:00
checkpoint_rm.md init submit all files 2020-11-18 13:32:27 -05:00
cluster.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_backup.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_create.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_ls.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_restore.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_rm.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_update.md init submit all files 2020-11-18 13:32:27 -05:00
cluster_version.md init submit all files 2020-11-18 13:32:27 -05:00
commit.md init submit all files 2020-11-18 13:32:27 -05:00
config.md init submit all files 2020-11-18 13:32:27 -05:00
config_create.md init submit all files 2020-11-18 13:32:27 -05:00
config_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
config_ls.md init submit all files 2020-11-18 13:32:27 -05:00
config_rm.md init submit all files 2020-11-18 13:32:27 -05:00
container.md init submit all files 2020-11-18 13:32:27 -05:00
container_attach.md init submit all files 2020-11-18 13:32:27 -05:00
container_commit.md init submit all files 2020-11-18 13:32:27 -05:00
container_cp.md init submit all files 2020-11-18 13:32:27 -05:00
container_create.md init submit all files 2020-11-18 13:32:27 -05:00
container_diff.md init submit all files 2020-11-18 13:32:27 -05:00
container_exec.md init submit all files 2020-11-18 13:32:27 -05:00
container_export.md init submit all files 2020-11-18 13:32:27 -05:00
container_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
container_kill.md init submit all files 2020-11-18 13:32:27 -05:00
container_logs.md init submit all files 2020-11-18 13:32:27 -05:00
container_ls.md init submit all files 2020-11-18 13:32:27 -05:00
container_pause.md init submit all files 2020-11-18 13:32:27 -05:00
container_port.md init submit all files 2020-11-18 13:32:27 -05:00
container_prune.md init submit all files 2020-11-18 13:32:27 -05:00
container_rename.md init submit all files 2020-11-18 13:32:27 -05:00
container_restart.md init submit all files 2020-11-18 13:32:27 -05:00
container_rm.md init submit all files 2020-11-18 13:32:27 -05:00
container_run.md init submit all files 2020-11-18 13:32:27 -05:00
container_start.md init submit all files 2020-11-18 13:32:27 -05:00
container_stats.md init submit all files 2020-11-18 13:32:27 -05:00
container_stop.md init submit all files 2020-11-18 13:32:27 -05:00
container_top.md init submit all files 2020-11-18 13:32:27 -05:00
container_unpause.md init submit all files 2020-11-18 13:32:27 -05:00
container_update.md init submit all files 2020-11-18 13:32:27 -05:00
container_wait.md init submit all files 2020-11-18 13:32:27 -05:00
context.md init submit all files 2020-11-18 13:32:27 -05:00
context_create.md init submit all files 2020-11-18 13:32:27 -05:00
context_export.md init submit all files 2020-11-18 13:32:27 -05:00
context_import.md init submit all files 2020-11-18 13:32:27 -05:00
context_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
context_ls.md init submit all files 2020-11-18 13:32:27 -05:00
context_rm.md init submit all files 2020-11-18 13:32:27 -05:00
context_update.md init submit all files 2020-11-18 13:32:27 -05:00
context_use.md init submit all files 2020-11-18 13:32:27 -05:00
cp.md init submit all files 2020-11-18 13:32:27 -05:00
create.md init submit all files 2020-11-18 13:32:27 -05:00
diff.md init submit all files 2020-11-18 13:32:27 -05:00
docker.md init submit all files 2020-11-18 13:32:27 -05:00
events.md init submit all files 2020-11-18 13:32:27 -05:00
exec.md init submit all files 2020-11-18 13:32:27 -05:00
export.md init submit all files 2020-11-18 13:32:27 -05:00
history.md init submit all files 2020-11-18 13:32:27 -05:00
image.md init submit all files 2020-11-18 13:32:27 -05:00
image_build.md init submit all files 2020-11-18 13:32:27 -05:00
image_history.md init submit all files 2020-11-18 13:32:27 -05:00
image_import.md init submit all files 2020-11-18 13:32:27 -05:00
image_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
image_load.md init submit all files 2020-11-18 13:32:27 -05:00
image_ls.md init submit all files 2020-11-18 13:32:27 -05:00
image_prune.md init submit all files 2020-11-18 13:32:27 -05:00
image_pull.md init submit all files 2020-11-18 13:32:27 -05:00
image_push.md init submit all files 2020-11-18 13:32:27 -05:00
image_rm.md init submit all files 2020-11-18 13:32:27 -05:00
image_save.md init submit all files 2020-11-18 13:32:27 -05:00
image_tag.md init submit all files 2020-11-18 13:32:27 -05:00
images.md init submit all files 2020-11-18 13:32:27 -05:00
import.md init submit all files 2020-11-18 13:32:27 -05:00
info.md init submit all files 2020-11-18 13:32:27 -05:00
inspect.md init submit all files 2020-11-18 13:32:27 -05:00
kill.md init submit all files 2020-11-18 13:32:27 -05:00
load.md init submit all files 2020-11-18 13:32:27 -05:00
login.md init submit all files 2020-11-18 13:32:27 -05:00
logout.md init submit all files 2020-11-18 13:32:27 -05:00
logs.md init submit all files 2020-11-18 13:32:27 -05:00
manifest.md init submit all files 2020-11-18 13:32:27 -05:00
manifest_annotate.md init submit all files 2020-11-18 13:32:27 -05:00
manifest_create.md init submit all files 2020-11-18 13:32:27 -05:00
manifest_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
manifest_push.md init submit all files 2020-11-18 13:32:27 -05:00
network.md init submit all files 2020-11-18 13:32:27 -05:00
network_connect.md init submit all files 2020-11-18 13:32:27 -05:00
network_create.md init submit all files 2020-11-18 13:32:27 -05:00
network_disconnect.md init submit all files 2020-11-18 13:32:27 -05:00
network_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
network_ls.md init submit all files 2020-11-18 13:32:27 -05:00
network_prune.md init submit all files 2020-11-18 13:32:27 -05:00
network_rm.md init submit all files 2020-11-18 13:32:27 -05:00
node.md init submit all files 2020-11-18 13:32:27 -05:00
node_demote.md init submit all files 2020-11-18 13:32:27 -05:00
node_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
node_ls.md init submit all files 2020-11-18 13:32:27 -05:00
node_promote.md init submit all files 2020-11-18 13:32:27 -05:00
node_ps.md init submit all files 2020-11-18 13:32:27 -05:00
node_rm.md init submit all files 2020-11-18 13:32:27 -05:00
node_update.md init submit all files 2020-11-18 13:32:27 -05:00
pause.md init submit all files 2020-11-18 13:32:27 -05:00
plugin.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_create.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_disable.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_enable.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_install.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_ls.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_push.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_rm.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_set.md init submit all files 2020-11-18 13:32:27 -05:00
plugin_upgrade.md init submit all files 2020-11-18 13:32:27 -05:00
port.md init submit all files 2020-11-18 13:32:27 -05:00
ps.md init submit all files 2020-11-18 13:32:27 -05:00
pull.md init submit all files 2020-11-18 13:32:27 -05:00
push.md init submit all files 2020-11-18 13:32:27 -05:00
registry.md init submit all files 2020-11-18 13:32:27 -05:00
registry_events.md init submit all files 2020-11-18 13:32:27 -05:00
registry_history.md init submit all files 2020-11-18 13:32:27 -05:00
registry_info.md init submit all files 2020-11-18 13:32:27 -05:00
registry_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
registry_joblogs.md init submit all files 2020-11-18 13:32:27 -05:00
registry_jobs.md init submit all files 2020-11-18 13:32:27 -05:00
registry_ls.md init submit all files 2020-11-18 13:32:27 -05:00
registry_rmi.md init submit all files 2020-11-18 13:32:27 -05:00
rename.md init submit all files 2020-11-18 13:32:27 -05:00
restart.md init submit all files 2020-11-18 13:32:27 -05:00
rm.md init submit all files 2020-11-18 13:32:27 -05:00
rmi.md init submit all files 2020-11-18 13:32:27 -05:00
run.md init submit all files 2020-11-18 13:32:27 -05:00
save.md init submit all files 2020-11-18 13:32:27 -05:00
search.md init submit all files 2020-11-18 13:32:27 -05:00
secret.md init submit all files 2020-11-18 13:32:27 -05:00
secret_create.md init submit all files 2020-11-18 13:32:27 -05:00
secret_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
secret_ls.md init submit all files 2020-11-18 13:32:27 -05:00
secret_rm.md init submit all files 2020-11-18 13:32:27 -05:00
service.md init submit all files 2020-11-18 13:32:27 -05:00
service_create.md init submit all files 2020-11-18 13:32:27 -05:00
service_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
service_logs.md init submit all files 2020-11-18 13:32:27 -05:00
service_ls.md init submit all files 2020-11-18 13:32:27 -05:00
service_ps.md init submit all files 2020-11-18 13:32:27 -05:00
service_rm.md init submit all files 2020-11-18 13:32:27 -05:00
service_rollback.md init submit all files 2020-11-18 13:32:27 -05:00
service_scale.md init submit all files 2020-11-18 13:32:27 -05:00
service_update.md init submit all files 2020-11-18 13:32:27 -05:00
stack.md init submit all files 2020-11-18 13:32:27 -05:00
stack_deploy.md init submit all files 2020-11-18 13:32:27 -05:00
stack_ls.md init submit all files 2020-11-18 13:32:27 -05:00
stack_ps.md init submit all files 2020-11-18 13:32:27 -05:00
stack_rm.md init submit all files 2020-11-18 13:32:27 -05:00
stack_services.md init submit all files 2020-11-18 13:32:27 -05:00
start.md init submit all files 2020-11-18 13:32:27 -05:00
stats.md init submit all files 2020-11-18 13:32:27 -05:00
stop.md init submit all files 2020-11-18 13:32:27 -05:00
swarm.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_ca.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_init.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_join-token.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_join.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_leave.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_unlock-key.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_unlock.md init submit all files 2020-11-18 13:32:27 -05:00
swarm_update.md init submit all files 2020-11-18 13:32:27 -05:00
system.md init submit all files 2020-11-18 13:32:27 -05:00
system_df.md init submit all files 2020-11-18 13:32:27 -05:00
system_events.md init submit all files 2020-11-18 13:32:27 -05:00
system_info.md init submit all files 2020-11-18 13:32:27 -05:00
system_prune.md init submit all files 2020-11-18 13:32:27 -05:00
tag.md init submit all files 2020-11-18 13:32:27 -05:00
top.md init submit all files 2020-11-18 13:32:27 -05:00
trust.md init submit all files 2020-11-18 13:32:27 -05:00
trust_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
trust_key.md init submit all files 2020-11-18 13:32:27 -05:00
trust_key_generate.md init submit all files 2020-11-18 13:32:27 -05:00
trust_key_load.md init submit all files 2020-11-18 13:32:27 -05:00
trust_revoke.md init submit all files 2020-11-18 13:32:27 -05:00
trust_sign.md init submit all files 2020-11-18 13:32:27 -05:00
trust_signer.md init submit all files 2020-11-18 13:32:27 -05:00
trust_signer_add.md init submit all files 2020-11-18 13:32:27 -05:00
trust_signer_remove.md init submit all files 2020-11-18 13:32:27 -05:00
unpause.md init submit all files 2020-11-18 13:32:27 -05:00
update.md init submit all files 2020-11-18 13:32:27 -05:00
version.md init submit all files 2020-11-18 13:32:27 -05:00
volume.md init submit all files 2020-11-18 13:32:27 -05:00
volume_create.md init submit all files 2020-11-18 13:32:27 -05:00
volume_inspect.md init submit all files 2020-11-18 13:32:27 -05:00
volume_ls.md init submit all files 2020-11-18 13:32:27 -05:00
volume_prune.md init submit all files 2020-11-18 13:32:27 -05:00
volume_rm.md init submit all files 2020-11-18 13:32:27 -05:00
wait.md init submit all files 2020-11-18 13:32:27 -05: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/cli 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/docker/cli/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 @thaJeztah. Be sure to generate the YAML files with the correct release branch of docker/cli, for example, the 19.03 branch.

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.