Package Exports
- yashveer
- yashveer/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (yashveer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
🎨 Yashveer CLI Portfolio
An interactive terminal-based portfolio built with React and Ink. Browse experience, projects, and skills directly from your terminal.
__ __ _ ____ _ ___ _______ _____ ____
\ \ / // \ / ___|| | | \ \ / / ____| ____| _ \
\ V // _ \ \___ \| |_| |\ \ / /| _| | _| | |_) |
| |/ ___ \ ___) | _ | \ V / | |___| |___| _ <
|_/_/ \_\____/|_| |_| \_/ |_____|_____|_| \_\Features
✨ Interactive CLI Experience
- Navigate through sections using arrow keys and Enter
- Animated content reveal for each section
- Styled boxes and colored text for visual appeal
📚 Sections
- About — Professional overview and experience summary
- Skills — Technical toolkit (18+ technologies)
- Work — Recent work experience and roles
- Projects — Open-source and side projects
- Contact — Selectable social media links (GitHub, LinkedIn, Twitter, Instagram)
⌨️ Keyboard Controls
- Arrow keys + Enter to navigate menus
- ESC to go back to menu
qto quit at any time
Installation
Global Install (Recommended)
npm install -g yashveer
yashveerVia npx (No Install)
npx yashveerLocal Development
Clone and run locally:
git clone <repo-url>
cd yashveer-cli
npm install
npm run build
node dist/index.jsDevelopment
Quick Start
npm install
npm run dev # Run with live TypeScript (no rebuild)
npm run build # Compile to dist/Project Structure
yashveer-cli/
├── src/
│ ├── index.tsx # Entry point with shebang
│ ├── App.tsx # Main app logic and routing
│ ├── components/
│ │ ├── Header.tsx # ASCII art + title
│ │ ├── Menu.tsx # Main navigation menu
│ │ ├── About.tsx # About section (animated)
│ │ ├── Skills.tsx # Skills list (animated)
│ │ ├── Work.tsx # Work experience (animated)
│ │ ├── Projects.tsx # Projects showcase (animated)
│ │ └── Contact.tsx # Social links (navigatable)
│ ├── hooks/
│ │ ├── useMenuNavigation.ts # Keyboard input handling
│ │ └── useRevealContent.ts # Animation reveal logic
│ └── data/
│ └── portfolio.ts # Portfolio content (single source of truth)
├── dist/ # Compiled output (auto-generated)
├── package.json
├── tsconfig.json
└── README.mdKey Technologies
- Ink — React renderer for CLIs
- React — UI component library
- chalk — Terminal color styling
- figlet — ASCII art text
- TypeScript — Type-safe development
- ink-select-input — Interactive menu selection
Editing Content
All portfolio content lives in src/data/portfolio.ts. Update:
- Name, title, about
- Skills array
- Work experience array
- Projects array
- Social links
Then rebuild:
npm run buildPublishing to npm
Prerequisites
- Create an npm account at npmjs.com
- Log in locally:
npm login
Publish
npm publishAfter publishing, anyone can run:
npx yashveerUpdate Version
Before republishing, update the version in package.json:
npm version patch # 1.0.0 → 1.0.1
npm version minor # 1.0.0 → 1.1.0
npm version major # 1.0.0 → 2.0.0
npm publishScripts
npm run build— Compile TypeScript to JavaScriptnpm run dev— Run with live TypeScript (no build step)npm run prepare— Automatically runs beforenpm publish
Navigation
Main Menu
Use arrow keys and Enter to select:
- About
- Skills
- Work Experience
- Projects
- Contact
- QuitIn Sections
- ESC → Back to menu
- q → Quit app
- Arrow keys + Enter → Select options (Contact section)
License
MIT — Feel free to fork, modify, and distribute!
Author
Yashveer Singh — Software Engineer & Frontend Specialist
- GitHub: singh-yashveer
- LinkedIn: singh-yashveer
- Twitter: @Citron5007
- Instagram: @yashvxxr.singh
Built with ❤️ using Ink and React