HydePHP Standalone CLI Manual

build

$ hyde build [options] [arguments]
Description:
  Build the static site

Usage:
  build [options]

Options:
      --run-dev         Run the NPM dev script after build
      --run-prod        Run the NPM prod script after build
      --run-prettier    Format the output using NPM Prettier
      --pretty-urls     Should links in output use pretty URLs?
      --no-api          Disable API calls, for example, Torchlight
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

debug

$ hyde debug [options] [arguments]
Description:
  Print debug information

Usage:
  debug

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

help

$ hyde help [options] [arguments]
Description:
  Display help for a command

Usage:
  help [options] [--] [<command_name>]

Arguments:
  command_name          The command name [default: "help"]

Options:
      --format=FORMAT   The output format (txt, xml, json, or md) [default: "txt"]
      --raw             To output raw command help
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  The help command displays help for a given command:

    hyde help list

  You can also output the help in other formats by using the --format option:

    hyde help --format=xml list

  To display the list of available commands, please use the list command.

list

$ hyde list [options] [arguments]
Description:
  List commands

Usage:
  list [options] [--] [<namespace>]

Arguments:
  namespace             The namespace name

Options:
      --raw             To output raw command list
      --format=FORMAT   The output format (txt, xml, json, or md) [default: "txt"]
      --short           To skip describing commands' arguments
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  The list command lists all commands:

    hyde list

  You can also display the commands for a specific namespace:

    hyde list test

  You can also output the information in other formats by using the --format option:

    hyde list --format=xml

  It's also possible to get raw list of commands (useful for embedding command runner):

    hyde list --raw

new

$ hyde new [options] [arguments]
Description:
  Create a new Hyde project.

Usage:
  new [<name>]

Arguments:
  name                  The name of the project

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

rebuild

$ hyde rebuild [options] [arguments]
Description:
  Run the static site builder for a single file

Usage:
  rebuild <path>

Arguments:
  path                  The relative file path (example: _posts/hello-world.md)

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

self-update

$ hyde self-update [options] [arguments]
Description:
  Update the standalone application to the latest version.

Usage:
  self-update [options]

Options:
      --check           Check for a new version without updating
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

serve

$ hyde serve [options] [arguments]
Description:
  Start the realtime compiler server

Usage:
  serve [options]

Options:
      --host[=HOST]                  [default: "localhost"]
      --port[=PORT]                  [default: 8080]
      --save-preview[=SAVE-PREVIEW]  Should the served page be saved to disk? (Overrides config setting)
      --dashboard[=DASHBOARD]        Enable the realtime compiler dashboard. (Overrides config setting)
      --pretty-urls[=PRETTY-URLS]    Enable pretty URLs. (Overrides config setting)
      --play-cdn[=PLAY-CDN]          Enable the Tailwind Play CDN. (Overrides config setting)
      --open                         Open the site preview in the browser.
  -h, --help                         Display help for the given command. When no command is given display help for the list command
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version
      --ansi|--no-ansi               Force (or disable --no-ansi) ANSI output
  -n, --no-interaction               Do not ask any interactive question
      --env[=ENV]                    The environment the command should run under
  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

validate

$ hyde validate [options] [arguments]
Description:
  Test and validate your project to optimize your site

Usage:
  validate

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  Run a series of tests to validate your setup and help you optimize your site

build:rss

$ hyde build:rss [options] [arguments]
Description:
  Generate the RSS feed

Usage:
  build:rss

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

build:search

$ hyde build:search [options] [arguments]
Description:
  Generate the documentation search index

Usage:
  build:search

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

build:sitemap

$ hyde build:sitemap [options] [arguments]
Description:
  Generate the sitemap.xml

Usage:
  build:sitemap

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

change:sourceDirectory

$ hyde change:sourceDirectory [options] [arguments]
Description:
  Change the source directory for your project

Usage:
  change:sourceDirectory <name>

Arguments:
  name                  The new source directory name

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

make:page

$ hyde make:page [options] [arguments]
Description:
  Scaffold a new Markdown, Blade, or documentation page file

Usage:
  make:page [options] [--] [<title>]

Arguments:
  title                 The name of the page file to create. Will be used to generate the slug

Options:
      --type[=TYPE]     The type of page to create (markdown, blade, or docs) [default: "markdown"]
      --blade           Create a Blade page
      --docs            Create a Documentation page
      --force           Overwrite any existing files
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

make:post

$ hyde make:post [options] [arguments]
Description:
  Scaffold a new Markdown blog post file

Usage:
  make:post [options] [--] [<title>]

Arguments:
  title                 The title for the Post. Will also be used to generate the filename

Options:
      --force           Should the generated file overwrite existing posts with the same filename?
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

package:discover

$ hyde package:discover [options] [arguments]
Description:
  Rebuild the cached package manifest

Usage:
  package:discover

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

publish:configs

$ hyde publish:configs [options] [arguments]
Description:
  Publish the default configuration files

Usage:
  publish:configs

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

publish:homepage

$ hyde publish:homepage [options] [arguments]
Description:
  Publish one of the default homepages to index.blade.php

Usage:
  publish:homepage [options] [--] [<homepage>]

Arguments:
  homepage              The name of the page to publish

Options:
      --force           Overwrite any existing files
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

publish:views

$ hyde publish:views [options] [arguments]
Description:
  Publish the hyde components for customization. Note that existing files will be overwritten

Usage:
  publish:views [<category>]

Arguments:
  category              The category to publish

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

route:list

$ hyde route:list [options] [arguments]
Description:
  Display all the registered routes

Usage:
  route:list

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

torchlight:install

$ hyde torchlight:install [options] [arguments]
Description:
  Install the Torchlight config file into your app.

Usage:
  torchlight:install

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

vendor:publish

$ hyde vendor:publish [options] [arguments]
Description:
  Publish any publishable assets from vendor packages

Usage:
  vendor:publish [options]

Options:
      --existing             Publish and overwrite only the files that have already been published
      --force                Overwrite any existing files
      --all                  Publish assets for all service providers without prompt
      --provider[=PROVIDER]  The service provider that has assets you want to publish
      --tag[=TAG]            One or many tags that have assets you want to publish (multiple values allowed)
  -h, --help                 Display help for the given command. When no command is given display help for the list command
  -q, --quiet                Do not output any message
  -V, --version              Display this application version
      --ansi|--no-ansi       Force (or disable --no-ansi) ANSI output
  -n, --no-interaction       Do not ask any interactive question
      --env[=ENV]            The environment the command should run under
  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug