Menu

Tree [503878] main /
 History

HTTPS access


File Date Author Commit
 assets 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit
 commands 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [17d9b6] feat(next-tailwind): "next js automation done a...
 config 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit
 terminal 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit
 utils 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit
 .gitignore 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit
 README.md 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [17d9b6] feat(next-tailwind): "next js automation done a...
 SHNK.spec 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit
 banner.py 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [17d9b6] feat(next-tailwind): "next js automation done a...
 main.py 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [17d9b6] feat(next-tailwind): "next js automation done a...
 requirements.txt 2025-06-06 Ganesh-Sharmaz Ganesh-Sharmaz [a34b3a] first commit

Read Me

🚀 SHNK - A simple CLI tool for automating daily tasks of a developer

A safe, futuristic, and developer-focused terminal CLI built in Python that combines aesthetics with practical development utilities.

✨ Features

🛠️ Developer Tools

  • Project Scaffolding
  • React + Tailwind CSS setup
  • Next.js + Tailwind CSS setup (coming soon)
  • Automated configuration and dependencies
  • Development server launch

🚀 Getting Started

Prerequisites

  • Python 3.8 or higher
  • pip (Python package manager)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/shnk.git
cd shnk
  1. Create and activate a virtual environment:
python -m venv .venv
# On Windows
.venv\Scripts\activate
# On Unix or MacOS
source .venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Run the application:
python main.py

🏗️ Project Structure

SHNK/
├── main.py                 # Application entry point
├── banner.py              # ASCII art and animations
├── commands/              # Project scaffolding commands
│   ├── react_tailwind.py
│   └── next_tailwind.py
├── terminal/              # Terminal functionality
│   ├── fs_commands.py
│   └── sandbox.py
├── utils/                 # Helper functions
│   ├── installer.py
│   └── logger.py
├── config/               # Configuration files
│   └── settings.json
├── assets/              # Static assets
│   └── ascii.txt
├── requirements.txt     # Project dependencies
└── README.md

🛠️ Development

Building from Source

  1. Install development dependencies:
pip install -r requirements.txt
  1. Run the development version:
python main.py

Creating an Executable

pyinstaller --onefile --clean --icon=assets/shnk.ico --name SHNK main.py

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

🐛 Known Issues

  • Next.js project scaffolding is currently in development
  • Some terminal commands are still being implemented

🔮 Roadmap

  • Vue.js + Tailwind project scaffolding
  • Express.js project setup
  • Command autocomplete
  • Custom themes support
  • Plugin system

📫 Contact

Your Name - @Ganesh_Sharmazz

Project Link: https://github.com/Ganesh-Sharma/SHNK