Skip to content

Latest commit

 

History

History
130 lines (92 loc) · 2.68 KB

README.md

File metadata and controls

130 lines (92 loc) · 2.68 KB

cli

Fiber Command Line Interface

Packaging status

Installation

# for go version since 1.16
go install github.com/gofiber/cli/fiber@latest
# for go version smaller than 1.16
go get -u github.com/gofiber/cli/fiber

Commands

fiber

Synopsis

🚀 Fiber is an Express inspired web framework written in Go with 💖

Learn more on https://gofiber.io

CLI version v0.0.x

Options

  -h, --help   help for fiber

fiber dev

Synopsis

Rerun the fiber project if watched files changed

fiber dev [flags]

Examples

  fiber dev --pre-run="command1 flag,command2 flag"
  Pre run specific commands before running the project

Options

  -a, --args strings            arguments for exec
  -d, --delay duration          delay to trigger rerun (default 1s)
  -D, --exclude_dirs strings    ignore these directories (default [assets,tmp,vendor,node_modules])
  -F, --exclude_files strings   ignore these files
  -e, --extensions strings      file extensions to watch (default [go,tmpl,tpl,html])
  -h, --help                    help for dev
  -p, --pre-run strings         pre run commands, see example for more detail
  -r, --root string             root path for watch, all files must be under root (default ".")
  -t, --target string           target path for go build (default ".")

fiber new

Synopsis

Generate a new fiber project

fiber new PROJECT [module name] [flags]

Examples

  fiber new fiber-demo
  Generates a project with go module name fiber-demo

  fiber new fiber-demo your.own/module/name
  Specific the go module name

  fiber new fiber-demo -t=complex
  Generate a complex project

  fiber new fiber-demo -t complex -r githubId/repo
  Generate project based on Github repo

  fiber new fiber-demo -t complex -r https://anyProvider.com/username/repo.git
  Generate project based on repo outside Github with https

  fiber new fiber-demo -t complex -r [email protected]:id/repo.git
  Generate project based on repo outside Github with ssh

Options

  -h, --help              help for new
  -r, --repo string       complex boilerplate repo name in github or other repo url (default "gofiber/boilerplate")
  -t, --template string   basic|complex (default "basic")

fiber upgrade

Synopsis

Upgrade Fiber cli if a newer version is available

fiber upgrade [flags]

Options

  -h, --help   help for upgrade

fiber version

Synopsis

Print the local and released version number of fiber

fiber version [flags]

Options

  -h, --help   help for version