summaryrefslogtreecommitdiffstats
path: root/docs/content/overview/usage.md
blob: 3f022a16ac801b86bb9012064bf76ad9a129abb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
title: "Using Hugo"
date: "2013-07-01"
aliases: ["/doc/usage/"]
---

Make sure either hugo is in your path or provide a path to it.

    $ hugo --help
    usage: hugo [flags] []
      -b, --base-url="": hostname (and path) to the root eg. http://spf13.com/
      -D, --build-drafts=false: include content marked as draft
          --config="": config file (default is path/config.yaml|json|toml)
      -d, --destination="": filesystem path to write files to
      -h, --help=false: show this help
          --port="1313": port to run web server on, default :1313
      -S, --server=false: run a (very) simple web server
      -s, --source="": filesystem path to read files relative from
          --uglyurls=false: if true, use /filename.html instead of /filename/
      -v, --verbose=false: verbose output
          --version=false: which version of hugo
      -w, --watch=false: watch filesystem for changes and recreate as needed

## Common Usage Example:

The most common use is probably to run hugo with your current
directory being the input directory.


    $ hugo
    > X pages created
    > Y indexes created
      in 8 ms


If you are working on things and want to see the changes
immediately, tell Hugo to watch for changes. **It will
recreate the site faster than you can tab over to
your browser to view the changes.**

    $ hugo -s ~/mysite --watch
       Watching for changes. Press ctrl+c to stop
       15 pages created
       0 tags created
       in 8 ms

Hugo can even run a server and create your site at the same time!

    $hugo --server -ws ~/mysite
       Watching for changes. Press ctrl+c to stop
       15 pages created
       0 tags created
       in 8 ms
       Web Server is available at http://localhost:1313
       Press ctrl+c to stop