shafikul-cli 2.0.1

CLI tool for FastAPI scaffolding with router, models, database, and templates.

Shafikul CLI

Shafikul CLI is a command-line tool to scaffold FastAPI projects quickly.
It helps you generate routers, models, database connections, HTML templates, full complete application with proper folder structure and auto updates for main.py and .env file.

---

Features

• ✅ Create FastAPI routers, models, and database modules
• ✅ Auto-generate main.py with imports and DB setup
• ✅ Auto-generate or update .env file
• ✅ Create HTML templates (index.html or custom names)
• ✅ Interactive CLI (numeric and text options)
• ✅ Colored console output
• ✅ Version commands (--version, -v, -V)
• ✅ About commands (--about, -a, -A)

---

Installation

Install from PyPI:

pip install shafikul_cli

Or Locally (editable):

git clone https://github.com/build-with-shafikul/shafikul_cli.git
cd shafikul_cli
pip install -e .

CLI help

shafikul_cli --help

Show version

shafikul_cli --version

About CLI

shafikul_cli --about

Create resources

shafikul_cli create app

Interactive Option

1: router
2: models
3: database
4: html
5: structure

You can select by number or by name Example for HTML template:
shafikul create app html
Enter file name default [index.html]: home.html

Database creation also auto updates main.py and .env

Project Structure

project_root/
│   .env
│   .gitignore
│   alembic.ini
│   main.py
│   README.md
│   requirements.txt
│   test.db
│   
├───app
│   │   database.py
│   │   models.py
│           
├───asset
│   ├───css
│   ├───images
│   └───js
├───migrations
│   │   env.py
│   │   README
│   │   
│   ├───versions
│   │   │   b6bbf47f6a8a_create_users_table.py
│           
├───router
│       users.py
│       __init__.py
│       
├───static
│   └───images
│           logo.png
│           
├───templates
│       index.html
│       notfound.html
│       
└───utility
        helper_function.py

Development

If you want to contribute:
Fork the repo ↗
Create a feature branch: git checkout -b feature-name
Commit your changes: git commit -m "Add feature"
Push to the branch: git push origin feature-name
Open a Pull Request

License

MIT License

Author

Md Shafikul Islam GitHub ↗