@stacksjs/gitit
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

Social Card of this repo

npm version GitHub Actions Commitizen friendly

gitit

A powerful template and project scaffolding tool to help kick-start development of your next project.

Features

Gitit comes with the following features:

  • 🚀 Fast Template Cloning Clone templates from GitHub, GitLab, Bitbucket, and more
  • 💪 Fully Typed APIs Written in TypeScript for a great developer experience
  • 📦 Zero Configuration Works out of the box with sensible defaults
  • 🔄 Offline Support Use cached templates when offline
  • 🛠️ Customizable Configure templates with various options
  • 🧩 Post-Installation Commands Run custom commands after cloning
  • 🔑 Private Repository Support Authentication for private templates
  • 🖥️ Interactive Shell Open a shell in your newly created project

Get Started

# Install globally
bun install -g @stacksjs/gitit

# or use directly with bunx
bunx @stacksjs/gitit github:user/repo my-project

Usage

# Basic usage
gitit github:user/repo my-project

# With options
gitit github:user/repo my-project --install --shell

# Clone with custom command
gitit github:user/repo my-project --command "npm run dev"

# Use offline cached template
gitit github:user/repo my-project --offline

# Clone to a specific directory
gitit github:user/repo ./path/to/project

Available Options

Option Description
--force Clone to existing directory even if it exists
--force-clean Remove any existing directory or file recursively before cloning
--shell Open a new shell with current working directory
--install Install dependencies after cloning
--verbose Show verbose debugging info
--command Custom command to run after template is cloned
--auth Custom Authorization token for private repositories
--cwd Set current working directory to resolve dirs relative to it
--offline Do not attempt to download and use cached version
--prefer-offline Use cache if exists otherwise try to download

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙

Dependents (0)

Package Sidebar

Install

npm i @stacksjs/gitit

Weekly Downloads

26

Version

0.2.1

License

MIT

Unpacked Size

87.5 kB

Total Files

12

Last publish

Collaborators

  • chrisbreuer