📇 NPM card

My personal CLI card. Run npx samxiao to see it in action!

👀 Preview

npx samxiao

This will display an interactive CLI business card with:

• 💼 Professional information
• 🔗 Social links
• 💌 Direct email option
• 🎨 Custom styling and emojis
• 🖼️ Centered layout with decorative borders

🚀 Create Your Own

Want to make your own CLI business card? Follow these steps:

1. Fork this repository
2. Clone your fork:

git clone https://github.com/samxiao/npx-card.git
cd npx-card

3. Install dependencies:

npm install

4. Edit the configuration in src/config.js:

const data = {
  name: bold.green('YOUR NAME'),
  email: bold.green('[email protected]'),
  handle: cyan('@your_handle'),
  // ... customize other fields
};

5. Customize the styling:

• Modify colors using chalk
• Change border styles
• Add your own emojis
• Update the decorative elements

6. Test your changes:

npm start

7. Publish to npm:

# Login to npm if you haven't
npm login

# Update package.json with your details
# Change "name", "author", and "bin" fields

# Publish!
npm publish

🛠️ Technologies Used

• Node.js
• boxen - Create boxes in the terminal
• chalk - Terminal string styling
• inquirer - Interactive CLI prompts
• open - Open URLs and email client

📦 Package Structure

.
├── src/
│   ├── config.js     # Your personal information
│   └── index.js      # Main CLI logic
├── package.json      # Project configuration
└── README.md        # Documentation

⚙️ Configuration Options

In src/config.js, you can customize:

• name: Your display name
• email: Contact email
• handle: Social media handle
• npm, github, linkedin: Social links
• firstPhrase, secondPhrase: Bio information
• borderColor: Box border color
• borderStyle: Box style ('single', 'double', 'round', etc.)

📜 License

MIT © Syed Mohammad Sameer

💖 Credits

Inspired by amazing developers(ultirequiem,ShreyamMaity) in the npm community who create CLI name cards.

🤝 Contributing

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