Skip to content

Commit

Permalink
feat: add CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
a-h committed Apr 25, 2023
1 parent da42500 commit e2367ef
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions docs/docs/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# CLI

`templ` provides a command line interface. Most users will only need to run the `templ generate` command to generate Go code from `*.templ` files.

```
usage: templ <command> [parameters]
To see help text, you can run:
templ generate --help
templ fmt --help
templ lsp --help
templ migrate --help
templ version
examples:
templ generate
```

## Generating Go code from templ files

The `templ generate` command generates Go code from `*.templ` files in the current directory tree.

The command provides additional options:

```
-f string
Optionally generates code for a single file, e.g. -f header.templ
-help
Print help and exit.
-path string
Generates code for all files in path. (default ".")
-sourceMapVisualisations
Set to true to generate HTML files to visualise the templ code and its corresponding Go code.
-w int
Number of workers to run in parallel. (default 4)
```

For example, to generate code for a single file:

```
templ generate -f header.templ
```

## Formatting templ files

The `templ fmt` command formats template files. You can use this command in different ways:

1. Format all template files in the current directory and subdirectories:

```
templ fmt .
```

2. Format input from stdin and output to stdout:

```
templ fmt
```

## Language Server for IDE integration

`templ lsp` provides a Language Server Protocol (LSP) implementation to support IDE integrations.

This command isn't intended to be used directly by users, but is used by IDE integrations such as the VSCode extension and by Neovim support.

A number of additional options are provided to enable runtime logging and profiling tools.

```
-goplsLog string
The file to log gopls output, or leave empty to disable logging.
-goplsRPCTrace
Set gopls to log input and output messages.
-help
Print help and exit.
-http string
Enable http debug server by setting a listen address (e.g. localhost:7474)
-log string
The file to log templ LSP output to, or leave empty to disable logging.
-pprof
Enable pprof web server (default address is localhost:9999)
```

0 comments on commit e2367ef

Please sign in to comment.