DocPad: Interactive CLI Prototyping

example-output.txt

Welcome to DocPad
DocPad GUI started on port {docpadGuiPort}

You're currently {docpadMood} with DocPad. Thanks for letting us know.

Execute your commands here:

> help

	Notes:

		[something] 						indicates optional variable
		{something}							indicates required variable


	Running the docpad command:

		docpad [command] 					without a command, docpad will start in interactive mode
		 									with a command, docpad will just run that particular command and then exit
			--nogui 						don't start the gui server
											not started if already running, or if we were run with a command


	Global commands:

		upgrade 							upgrade docpad installation, upgrade plugins

		plugin cache {pluginName}			cache the plugin
		plugin cached 						list the cached plugins
		plugin list 						list the available plugins

		skeleton cache {skeletonName} 		cache the skeleton
		skeleton cached 					list the cached skeletons
		skeleton list 						list the available skeletons

		info 								provide information on how docpad will run
		help 								show the help you're viewing right now

		mood happy ["message"]				set your mood to happy, with an optional message
		mood sad ["message"]				set your mood to sad, with an optional message
		feedback {"message"}				provide feedback to docpad

		config --global list 				list global configuration keys and their values
		config --global set {key} {value}	set a global configuration value
		config --global get {key}			get a global configuration value


	Poject specific commands:

		install 							(re-)install anything worth installing (e.g. plugins, dependencies)
		scaffold {skeletonName} 			clone out a particular skeleton to use for this project
		generate							perform a generate of the project
		server {serverPort?} 				start the server for the project
		watch								turn watching on
		watch off							turn watching off

		plugin install {pluginName} 		install a plugin to the project
		plugin delete {pluginName}			delete a plugin from the project
		plugin installed 					lists the installed plugins for the project

		plugin enable {pluginName}			enable a plugin
		plugin disable {pluginName}			disable a plugin
		plugin enabled						list enabled plugins
		plugin disabled						list disabled plugins

		plugin create {pluginName}			create a empty plugin inside the project
		plugin publish {pluginName} 		publish a plugin you've created

		config list 						list local configuration keys and their values
		config set {key} {value}			set a configuration value
		config get {key}					get a configuration value



> info

	DocPad:
		version: {docpadVersion} (is latest/outdated, please upgrade to 1.2.4 by running `docpad upgrade`)
		guiServerPort: {docpadGuiServerPort}
		cachedPlugins: (57 total)
			- ...
		cachedSkeletons: (3 total)
			- ...

	Project:
		name: {projectName}
		version: {projectVersion}
		serverPort: {projectServerPort}
		skeleton: {skeletonName}
		plugins:
			enabled: (3 total)
				- ...
			installed: (5 total)
				- ...