pfolio 📚

A beautiful CLI tool to view GitHub portfolio README files directly in your terminal.

Features

• 🚀 Instant viewing - View any GitHub user's README with a single command
• 🎨 Beautiful rendering - Markdown content rendered with syntax highlighting
• ⌨️ Keyboard navigation - Scroll through content with intuitive controls
• 🔗 Interactive links - Press 'a' for quick action menu with clickable links
• 🎯 Fully customizable - Custom themes, content, and interactive links
• 📱 Responsive - Adapts to your terminal size
• 🧹 Clean output - Filters out HTML comments for cleaner display

Installation

# Run directly with npx (recommended)
npx pfolio <username>

# Or install globally
npm install -g pfolio

Usage

# View a user's GitHub README
npx pfolio deanward

# View your own README
npx pfolio yourusername

The tool fetches the README.md file from https://github.com/username/username repository and displays it in a beautiful terminal interface.

Navigation

Once the README is loaded, use these keyboard shortcuts:

• ↑/↓ - Scroll line by line
• Page Up/Page Down - Scroll page by page
• g - Go to start
• G - Go to end
• a - Open action menu (if links are configured)
• q - Quit

Examples

# View popular developers' portfolios
npx pfolio sindresorhus
npx pfolio gaearon
npx pfolio tj
npx pfolio addyosmani

Customization

Create a personalized portfolio experience:

• portfolix.md - Custom content optimized for terminal viewing
• .portfolix.json - Custom themes, colors, and interactive links

See CUSTOMIZATION.md for complete documentation and examples.

How it works

1. Takes a GitHub username as argument
2. Fetches content from username/username repository:
   • portfolix.md (if it exists) or README.md (fallback)
   • .portfolix.json (for customization)
3. Renders the markdown content in a beautiful terminal interface
4. Provides smooth scrolling, navigation, and interactive features

Requirements

• Node.js 14 or higher
• Terminal with color support (most modern terminals)

Development

# Clone the repository
git clone https://github.com/deanward/pfolio.git
cd pfolio

# Install dependencies
npm install

# Build the project
npm run build

# Test locally
npm start <username>

# Watch mode for development
npm run dev

Contributing

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

License

ISC

Author

Created with ❤️ for the developer community

Tip: Create a special repository with your username (e.g., github.com/yourusername/yourusername) and add a README.md to showcase your profile!