diff --git a/src/composer/cli/cmdline.py b/src/composer/cli/cmdline.py index d9ff5e50..0dda1c1a 100644 --- a/src/composer/cli/cmdline.py +++ b/src/composer/cli/cmdline.py @@ -19,113 +19,10 @@ import sys import argparse from composer import vernum +from composer.cli.help import epilog VERSION = "{0}-{1}".format(os.path.basename(sys.argv[0]), vernum) -# Documentation for the commands -epilog = """ -compose start - Start a compose using the selected blueprint and output type. - -compose types - List the supported output types. - -compose status - List the status of all running and finished composes. - -compose log [] - Show the last SIZE kB of the compose log. - -compose cancel - Cancel a running compose and delete any intermediate results. - -compose delete - Delete the listed compose results. - -compose info - Show detailed information on the compose. - -compose metadata - Download the metadata use to create the compose to -metadata.tar - -compose logs - Download the compose logs to -logs.tar - -compose results - Download all of the compose results; metadata, logs, and image to .tar - -compose image - Download the output image from the compose. Filename depends on the type. - -blueprints list - List the names of the available blueprints. - -blueprints show - Display the blueprint in TOML format. - -blueprints changes - Display the changes for each blueprint. - -blueprints diff - Display the differences between 2 versions of a blueprint. - FROM-COMMIT can be a commit hash or NEWEST - TO-COMMIT can be a commit hash, NEWEST, or WORKSPACE - -blueprints save - Save the blueprint to a file, .toml - -blueprints delete - Delete a blueprint from the server - -blueprints depsolve - Display the packages needed to install the blueprint. - -blueprints push - Push a blueprint TOML file to the server. - -blueprints freeze - Display the frozen blueprint's modules and packages. - -blueprints freeze show - Display the frozen blueprint in TOML format. - -blueprints freeze save - Save the frozen blueprint to a file, .frozen.toml. - -blueprints tag - Tag the most recent blueprint commit as a release. - -blueprints undo - Undo changes to a blueprint by reverting to the selected commit. - -blueprints workspace - Push the blueprint TOML to the temporary workspace storage. - -modules list - List the available modules. - -projects list - List the available projects. - -projects info - Show details about the listed projects. - -sources list - List the available sources - -sources info - Details about the source. - -sources add - Add a package source to the server. - -sources change - Change an existing source - -sources delete - Delete a package source. -""" - def composer_cli_parser(): """ Return the ArgumentParser for composer-cli""" diff --git a/src/composer/cli/help.py b/src/composer/cli/help.py new file mode 100644 index 00000000..03e9adb9 --- /dev/null +++ b/src/composer/cli/help.py @@ -0,0 +1,129 @@ +# Copyright (C) 2018 Red Hat, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +# Documentation for the commands +compose_help = """ +compose start + Start a compose using the selected blueprint and output type. + +compose types + List the supported output types. + +compose status + List the status of all running and finished composes. + +compose log [] + Show the last SIZE kB of the compose log. + +compose cancel + Cancel a running compose and delete any intermediate results. + +compose delete + Delete the listed compose results. + +compose info + Show detailed information on the compose. + +compose metadata + Download the metadata use to create the compose to -metadata.tar + +compose logs + Download the compose logs to -logs.tar + +compose results + Download all of the compose results; metadata, logs, and image to .tar + +compose image + Download the output image from the compose. Filename depends on the type. +""" + +blueprints_help = """ +blueprints list + List the names of the available blueprints. + +blueprints show + Display the blueprint in TOML format. + +blueprints changes + Display the changes for each blueprint. + +blueprints diff + Display the differences between 2 versions of a blueprint. + FROM-COMMIT can be a commit hash or NEWEST + TO-COMMIT can be a commit hash, NEWEST, or WORKSPACE + +blueprints save + Save the blueprint to a file, .toml + +blueprints delete + Delete a blueprint from the server + +blueprints depsolve + Display the packages needed to install the blueprint. + +blueprints push + Push a blueprint TOML file to the server. + +blueprints freeze + Display the frozen blueprint's modules and packages. + +blueprints freeze show + Display the frozen blueprint in TOML format. + +blueprints freeze save + Save the frozen blueprint to a file, .frozen.toml. + +blueprints tag + Tag the most recent blueprint commit as a release. + +blueprints undo + Undo changes to a blueprint by reverting to the selected commit. + +blueprints workspace + Push the blueprint TOML to the temporary workspace storage. +""" + +modules_help = """ +modules list + List the available modules. +""" + +projects_help = """ +projects list + List the available projects. + +projects info + Show details about the listed projects. +""" + +sources_help = """ +sources list + List the available sources + +sources info + Details about the source. + +sources add + Add a package source to the server. + +sources change + Change an existing source + +sources delete + Delete a package source. +""" + +epilog = compose_help + blueprints_help + modules_help + projects_help + sources_help