satya-portfolio-cli
v1.0.2
Published
Generate hacker-style terminal portfolio websites
Maintainers
Readme
🚀 satya-portfolio-cli
Generate hacker-style terminal portfolio websites directly from your CLI.
⚡ Features
- Interactive terminal portfolio
- Dynamic commands
- Hacker-style UI
- Resume support
- Smart command suggestions
- Dynamic projects, skills, certifications, education
- Personalized shell identity
- ASCII branding using figlet
- Supports local resume PDF or resume URL
- Fully generated static portfolio website
📦 Installation
Run instantly using:
npx satya-portfolio-cliOR install globally:
npm install -g satya-portfolio-cli🖥️ Commands Supported
Inside generated portfolio:
help
about
skills
projects
experience
education
certs
contact
resume
whoami
clear✨ Example
? Your name: Satya
? Terminal username: neo
? Terminal hostname: matrix
? Skills: React, FastAPI, Node.jsGenerates:
neo@matrix:~ ❯Interactive terminal portfolio website.
⚙️ Workflow
flowchart TD
A[User Runs CLI] --> B[Interactive Prompts]
B --> C[Collect Portfolio Data]
C --> D[Generate HTML Portfolio]
D --> E[Create Resume Integration]
E --> F[Export Portfolio Folder]
F --> G[Open index.html]🏗️ Architecture Diagram
flowchart LR
A[CLI Interface]
--> B[Inquirer Prompts]
B --> C[Portfolio Data Object]
C --> D[HTML Template Engine]
D --> E[Generated Portfolio Website]💻 Terminal Command Flow
flowchart TD
A[User Types Command]
--> B{Command Exists?}
B -->|Yes| C[Render Section]
B -->|No| D[Show Suggestions]
C --> E[Display Terminal Output]
D --> E⚙️ How It Works
npx satya-portfolio-cli
↓
Interactive CLI prompts
↓
Portfolio data collection
↓
HTML template generation
↓
Interactive terminal portfolio website📁 Generated Structure
portfolio/
├── index.html
└── resume.pdf🔥 Screenshots
Terminal Portfolio Preview
🛠️ Tech Stack
- Node.js
- Inquirer.js
- Chalk
- Figlet
- fs-extra
🚀 Publish Your Portfolio
After generation:
- Open
portfolio/index.html - Deploy using:
- GitHub Pages
- Netlify
- Vercel
🚧 Roadmap
- [x] Interactive terminal portfolio
- [x] Resume support
- [x] Smart command suggestions
- [x] Dynamic portfolio generation
- [ ] Multiple themes
- [ ] One-click deployment
- [ ] AI resume-to-portfolio generation
- [ ] Live preview mode
📌 npm Package
npm install -g satya-portfolio-cliOR
npx satya-portfolio-cli👨💻 Author
Satyavardhan Koyalkar
GitHub: https://github.com/satyavardhankoyalkar
LinkedIn: https://www.linkedin.com/in/satyavardhan-koyalkar-5ba794/
⭐ Support
If you like this project:
- Star the repo
- Share it
- Build cool portfolios 😎
📄 License
MIT License
