pipi-cli 0.1.1

Pipi new app generator
Documentation

Pipi CLI

Pipi is a powerful framework designed to streamline the development of modern web applications with a focus on ease of use and flexibility. Whether you're building a SaaS app, a REST API, or a minimal service, Pipi provides the tools you need to get started quickly and scale as your application grows. With built-in configuration for popular databases, background workers, and asset serving options, Pipi gives you the power to customize your project to fit your needs.

Templates Versatile Options

Pipi empowers you to tailor your project to fit a variety of needs. Here are some of the versatile options it offers:

Application Types

  • SaaS Applications: Create platforms with features like user authentication, database integration, and scalable background processing.
  • REST APIs: Build robust APIs with database support, authentication, and modular controllers.
  • Lightweight Services: Focus on simplicity with minimal setups that include only essential controllers and views.

Advanced Customization

Pipi is designed to offer advanced customization to meet the unique needs of your project. Whether you need a simple app that can evolve over time or a complex application that requires a specific configuration, Pipi provides the flexibility to fine-tune your setup.

Getting Started

Install the Pipi CLI from crates.io:

cargo install pipi-cli

The crate is named pipi-cli, but it installs the pipi binary globally, making it accessible from anywhere in your terminal.

Create a New Project:

Once installed, you can create a new Pipi project by running the following command:

pipi new

This will initiate a wizard that will guide you through the process of setting up your project.

Generated projects depend on the pipi-rs framework crate:

pipi = { package = "pipi-rs", version = "0.1.1" }

For framework development, use PIPI_DEV_MODE_PATH to make generated projects point at your local checkout:

PIPI_DEV_MODE_PATH=/absolute/path/to/pipi pipi new

Upgrade

The Pipi CLI is bundled with the Pipi framework create version. To ensure you're using the latest version of Pipi and to get the most up-to-date templates, simply run the following command:

cargo install pipi-cli --force

This will update the Pipi CLI to the latest version, replacing the existing pipi binary with the newest release. After upgrading, any new templates you generate will reflect the latest features and improvements.