You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

cli-usage.md 1.3KB

7 years ago
7 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. +++
  2. title = "CLI usage"
  3. weight = 2
  4. +++
  5. Gutenberg only has 3 commands: init, build and serve.
  6. You can view the help of the whole program by running `gutenberg --help` and
  7. the command help by running `gutenberg <cmd> --help`.
  8. ## init
  9. Creates the directory structure used by Gutenberg at the given directory.
  10. ```bash
  11. $ gutenberg init <my_site>
  12. ```
  13. will create a new folder named `my_site` and the files/folders needed by
  14. Gutenberg.
  15. ## build
  16. This will build the whole site in the `public` directory.
  17. ```bash
  18. $ gutenberg build
  19. ```
  20. You can override the config `base_url` by passing a new URL to the `base-url` flag.
  21. ```bash
  22. $ gutenberg build --base-url https://59a896e2cf321c2dcfd2d6de--tera.netlify.com/
  23. ```
  24. ## serve
  25. This will build and serve the site using a local server. You can also specify
  26. the interface/port combination to use if you want something different than the default (`127.0.0.1:1111`).
  27. ```bash
  28. $ gutenberg serve
  29. $ gutenberg serve --port 2000
  30. $ gutenberg serve --interface 0.0.0.0
  31. $ gutenberg serve --interface 0.0.0.0 --port 2000
  32. ```
  33. The serve command will watch all your content and will provide live reload, without
  34. hard refresh if possible.
  35. If you fail to see your change, this means that Gutenberg couldn't reload that bit and you will
  36. need to restart `gutenberg serve`.