Get Started
Basics
Web Sockets
Server Sent Events
Guards
Views
Web Standards
Cli
Schema
Migrate
Build Checkpoints
Type Definitions
Snapshots
Docker
Issues
Contributing
Faq
Cli
 The cli provides various commands to manage your project lifecycle, from creation to deployment.

Create Project
 
frizzante create my_project
# or frizzante c my_project
Creates a new project in a new directory using the given name.


Generate
 
frizzante generate
# or frizzante g
This command generates code and/or resources.
Note
Many of frizzante’s functionalities come as code and resource generations, not as packages.


Configure
 
frizzante configure
Runs
  1. frizzante generate air,bun
  2. frizzante install
  3. frizzante package
  4. frizzante migrate
This will generate Air and Bun binaries in .gen/{air,bun} .


Install
 
frizzante install
# or frizzante i
Installs Go and JavaScript packages from go.mod and app/package.json .
Note
JavaScript packages are installed using .gen/bun/bun by default. You can point to a custom Bun binary of your choice by setting --bun . For example, the following will install JavaScript packages using a ~/.bun/bun binary 
frizzante --bun=~/.bun/bun install
Alternatively you can also use a global binary. 
frizzante --bun=bun install
This will force the cli to use the binary present in your path.


Update
 
frizzante update
# or frizzante u
Updates Go and JavaScript packages from go.mod and app/package.json .
Note
JavaScript packages are updated using .gen/bun/bun by default. You can point to a custom Bun binary of your choice by setting --bun For example, the following will update JavaScript packages using a ~/.bun/bun binary 
frizzante --bun=~/.bun/bun update
Alternatively you can also use a global binary. 
frizzante --bun=bun update
This will force the cli to use the binary present in your path.


Package
 
frizzante package
# or frizzante p
Runs vite build and vite build --ssr in order to package the the app directory into app/dist .
The output contains a client directory which can be simply served as is to the client and a app.server.js file that can be executed on the server in order to render the contents of the application in advanced.
Note
Your app directory is packaged using .gen/bun/bun by default. You can point to a custom Bun binary of your choice by setting --bun .

For example, the following will package your app using a ~/.bun/bun binary 
frizzante --bun=~/.bun/bun package
Alternatively you can also use a global binary. 
frizzante --bun=bun package
This will force the cli to use the binary present in your path.


Package Watch
 
frizzante package-watch
Runs frizzante package in watch mode.
Note
This will detect changes made only in the app directory.


Dev
 
frizzante dev
# or frizzante d
Runs Air and frizzante package-watch in parallel.
Note
The cli uses .gen/air/air by default. You can point to a custom Air binary of your choice by setting --air .

For example, the following will run air using a ~/.air/air binary. 
frizzante --air=~/.air/air dev
You can also use a global binary. 
frizzante --air=air dev
Or even use custom paths for both Air and Bun. 
frizzante --air=air --bun=bun dev


Migrate
 
frizzante migrate
Runs the ./migrate program.
Note
Fore more details on migrations see the migrate guide.


Build
 
frizzante build
# or frizzante b
Runs frizzante package and then builds the ./migrate program and the main Go program in .gen/bin/migrate and .gen/bin/start .
Note
You can specify the output directory of the build process with --output
Tip
You can pass no-package as an argument in order to omit packaging the frontend bundles.

This is useful when you want to build your native binary for multiple platforms at once, for example 
#!/usr/bin/env bash
frizzante package
GOOS=windows GOARCH=amd64 frizzante build --output=".gen/bin/windows-amd64" no-package &\
GOOS=linux GOARCH=amd64 frizzante build --output=".gen/bin/linux-amd64" no-package &\
GOOS=linux GOARCH=arm64 frizzante build --output=".gen/bin/linux-arm64" no-package &\
GOOS=darwin GOARCH=amd64 frizzante build --output=".gen/bin/darwin-amd64" no-package &\
GOOS=darwin GOARCH=arm64 frizzante build --output=".gen/bin/darwin-arm64" no-package &\
wait
This script will build your web bundles once and then build the native binary for each platform in parallel.


Check
 
frizzante check
Runs eslint and svelte-check in your app directory in order to detect code syntax and style errors.
Note
Checks are run using .gen/bun/bun by default. You can point to a custom Bun binary of your choice by setting --bun . For example, the following will check your app using a ~/.bun/bun binary. 
frizzante --bun=~/.bun/bun check
Alternatively you can also use a global binary. 
frizzante --bun=bun check
This will force the cli to use the binary present in your path.


Format
 
frizzante format
# or frizzante f
This will run go fmt ./... and prettier --write . in your app directory.
Note
Prettier is run using .gen/bun/bun by default. You can point to a custom Bun binary of your choice by setting --bun . For example, the following will format your app using a ~/.bun/bun binary. 
frizzante --bun=~/.bun/bun format
Alternatively you can also use a global binary. 
frizzante --bun=bun format
This will force the cli to use the binary present in your path.


Clean
 
frizzante clean
Removes .gen , app/dist , app/.vite , app/node_modules , cover.html , cover.out

Reset
 
frizzante reset
Deletes frizzante’s global cache.
Note
The global cache is located at ~/.frizzante by default.
Tip
You can configure this location by setting FRIZZANTE_HOME to whatever path you want in your environment variables.


Strict
 
frizzante --strict
# or frizzante -s
Normally frizzante will prompt the user for required parameters whenever they're being passed in.
The --strict flag disables this behavior and instead defaults to stopping the program whenever a required parameter is missing.
Tip
This is useful for ci/cd pipelines, automated scripts, batch operations and so on.


Version
 
frizzante version
# or frizzante v
Displays the version of the binary.
Previous
Web Standards
Next
Schema