Skip to content

Instantly share code, notes, and snippets.

@fjcero

fjcero/CommandsDocumentationTemplate.md

Last active April 21, 2021 16:20
Show Gist options
  • Save fjcero/890d115263bec313c09a to your computer and use it in GitHub Desktop.
Save fjcero/890d115263bec313c09a to your computer and use it in GitHub Desktop.
Download ZIP
Documentation
Raw
CommandsDocumentationTemplate.md

Command Name

Description of the command.

Usage

Choose your flavor:

$ php bin/Hermes.php --execute CommandName [--option1="..."] [--option2="..."] [--optionN]
$ php app/console some:command arg1 arg2 argN [--option1="..."] [--option2="..."] [--optionN]
$ php bin/console some:command arg1 arg2 argN [--option1="..."] [--option2="..."] [--optionN]

Arguments

Argument Type Required Description
arg1 string required Some Arg description

Options

Option Type Value Default Description
Option1 string optional "" Description for your option

Examples

Example 1

Example Description

$ php bin/Hermes.php --execute Do Something
                     --option1 1
                     --option2 "test"

Exit Codes

All commands return an exit code 0 on success and 1 on error, even if they output to STDOUT. So it's safe to pipe them or use them in shell tests/expresions.

Jenkins

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment