Skip to main content

Hosanna Tools

Hosanna Tools is a command-line utility for managing Hosanna projects. It provides essential commands for creating new projects, updating the SDK, generating structs (which are required for Hosanna apps), and more.

Hosanna Tools CLI​

You can access the CLI using the hst command. Here are the available commands:

The CLI output includes the build date and version number. This helps developers verify they are using the correct version of the tools for their project.

hosanna-tools: Version: 0.6.0 (build date: 2025-08-04T18:51:06.015Z)
hst <command> [options]

Hosanna Tools CLI
Version: 0.6.0
Build Date: 2025-08-04T18:51:06.015Z

Commands:
  hst <command> [options]     Hosanna Tools CLI
                              Version: 0.6.0
                              Build Date: 2025-08-04T18:51:06.015Z     [default]
  hst generate                Generate structs and command handler maps
  hst clean                   Clean generated files
  hst create-view             Create a new view
  hst prepare-gitignore       Ensure .gitignore contains required entries
  hst update                  Update the SDK by cloning the repository, checking
                              out the branch or tag, and setting up symlinks
  hst install                 Install the SDK by creating hosanna.json and
                              setting up the environment
  hst create-template-app     Create a new template app with the Hosanna SDK

Options:
  --version  Show version number                                       [boolean]
  --help     View help information about this tool.                    [boolean]

Common Tasks​

  • Create a new project: Use hst create-template-app to scaffold a new Hosanna project with the SDK.

  • Install or update the SDK: Use hst install to set up the SDK and environment, or hst update to update the SDK to a specific branch or tag.

  • Generate structs: Use hst generate to generate structs and command handler maps, which are essential for Hosanna apps.

  • Clean generated files: Use hst clean to remove generated files from your project.

  • Create a new view: Use hst create-view to scaffold a new view in your project.

  • Prepare .gitignore: Use hst prepare-gitignore to ensure your .gitignore file contains all required entries.

For more information about each command, run hst --help.