DevSplash

A beautiful, extensible CLI splash screen for your dev workflow.

DevSplash greets developers with a customizable ASCII splash, dynamic project info, and onboarding tips every time you start your project. Perfect for open source, teams, and solo devs who want a delightful, informative CLI experience.

✨ Features

• Customizable ASCII splash screens (art, logo, or your own)
• Dynamic project info: Git branch, last commit, env vars, dev server port
• Onboarding tips for new contributors
• Links to docs, dashboards, or anything
• Color, frame, and alignment options
• Interactive setup wizard (npm run init-splash)
• Configurable via JSON, CLI flags, or env vars
• ESM & CJS compatible
• 100% test coverage

🚀 Quickstart

npm install --save-dev devsplash
npm run init-splash   # or: node dist/init.js

This launches the interactive setup wizard to create your devsplash.config.json.

🛠️ Usage

Add to your package.json scripts:

"scripts": {
  "start": "dev-splash && node your-app.js",
  "dev": "dev-splash && node your-app.js"
}

Or run directly:

npx dev-splash

🧙 Interactive Setup

Run:

npm run init-splash

Or, if developing:

npm run build
node dist/init.js

You'll be guided through:

• Project name & version
• ASCII art selection
  • Choose a preset, generate ASCII art from text and font (powered by figlet), or paste your own
  • Instantly preview your generated ASCII art and try different fonts
• Project links (GitHub, Docs, etc)
• Onboarding tips
• Color, frame, and alignment
• Dynamic fields (Git info, env vars, port)

💡 Tip: For custom ASCII art, you can generate it right in the wizard from any text and font, or paste art from patorjk.com/taag or your favorite generator.

🖼️ Example ASCII Art

Small

 ____  _           _     
|  _ \| |__   ___ | |__  
| | | | '_ \ / _ \| '_ \ 
| |_| | | | | (_) | | | |
|____/|_| |_|\___/|_| |_|

Medium

  ____                  ____        _           _     
 |  _ \  ___  ___  ___/ ___|  ___ | |__   ___ | |__  
 | | | |/ _ \/ __|/ _ \ |  _  / _ \| '_ \ / _ \| '_ \ 
 | |_| |  __/\__ \  __/ |_| | (_) | |_) | (_) | | | |
 |____/ \___||___/\___|\____|\___/|_.__/ \___/|_| |_|

Large

 _______                        ______             __                      __       
|       \                      /      \           |  \                    |  \      
| $$$$$$$\  ______  __     __ |  $$$$$$\  ______  | $$  ______    _______ | $$____  
| $$  | $$ /      \|  \   /  \| $$___\$$ /      \ | $$ |      \  /       \| $$    \ 
| $$  | $$|  $$$$$$\$$\ /  $$ \$$    \ |  $$$$$$\| $$  \$$$$$$\|  $$$$$$$| $$$$$$$\
| $$  | $$| $$    $$ \$$\  $$  _\$$$$$$\| $$  | $$| $$ /      $$ \$$    \ | $$  | $$
| $$__/ $$| $$$$$$$$  \$$ $$  |  \__| $$| $$__/ $$| $$|  $$$$$$$ _\$$$$$$\| $$  | $$
| $$    $$ \$$     \   \$$$    \$$    $$| $$    $$| $$ \$$    $$|       $$| $$  | $$
 \$$$$$$$   \$$$$$$$    \$      \$$$$$$ | $$$$$$$  \$$  \$$$$$$$ \$$$$$$$  \$$   \$$
                                        | $$                                        
                                        | $$                                        
                                         \$$                                        

 _______                        ______             __                      __       
|       \                      /      \           |  \                    |  \      
| $$$$$$$\  ______  __     __ |  $$$$$$\  ______  | $$  ______    _______ | $$____  
| $$  | $$ /      \|  \   /  \| $$___\$$ /      \ | $$ |      \  /       \| $$    \ 
| $$  | $$|  $$$$$$\$$\ /  $$ \$$    \ |  $$$$$$\| $$  \$$$$$$\|  $$$$$$$| $$$$$$$\
| $$  | $$| $$    $$ \$$\  $$  _\$$$$$$\| $$  | $$| $$ /      $$ \$$    \ | $$  | $$
| $$__/ $$| $$$$$$$$  \$$ $$  |  \__| $$| $$__/ $$| $$|  $$$$$$$ _\$$$$$$\| $$  | $$
| $$    $$ \$$     \   \$$$    \$$    $$| $$    $$| $$ \$$    $$|       $$| $$  | $$
 \$$$$$$$   \$$$$$$$    \$      \$$$$$$ | $$$$$$$  \$$  \$$$$$$$ \$$$$$$$  \$$   \$$
                                        | $$                                        
                                        | $$                                        
                                         \$$                                        

DevSplash v1.0.0

GitHub: https://github.com/yourorg/devsplash   Docs: https://yourorg.github.io/devsplash

Git Branch: main
Last Commit: abc1234 (2024-01-01)
NODE_ENV: development
PORT: 3000

💡 Tip: You can customize this splash with your own ASCII art!

⚙️ Config Schema (devsplash.config.json)

{
  "title": "Project Name",
  "version": "1.0.0",
  "asciiArt": "ASCII art string or path to file",
  "links": { "Docs": "https://..." },
  "tips": ["Tip 1", "Tip 2"],
  "style": {
    "color": "cyan",
    "frame": true,
    "align": "center"
  },
  "dynamicFields": {
    "branch": true,
    "lastCommit": true,
    "envVars": ["NODE_ENV", "PORT"],
    "port": true
  }
}

🏗️ Advanced CLI Options

• --config <path>: Load a custom config JSON file
• --no-frame: Disable the ASCII splash framing box
• --color <color>: Override default color
• --random-tip: Show a random onboarding tip
• --verbose: Show debug info during rendering

💡 Customization & Tips

• Use your own ASCII art or logo for branding
• Generate ASCII art from any text and font in the setup wizard (figlet-powered!)
• Add onboarding tips for new contributors
• Link to docs, issues, dashboards, or anything
• Show any env vars you want (e.g. NODE_ENV, PORT)
• Tweak color, frame, and alignment for your style

🧩 Extensibility & Vision

DevSplash is designed to be:

• Modular: Add new dynamic fields or integrations easily
• Team-friendly: Share onboarding, links, and tips
• Beautiful: Make your CLI a joy to use
• Open source: PRs and suggestions welcome!

🧪 Testing

npm test

🐛 Troubleshooting

• ESM/CJS issues? DevSplash is ESM-first. If you use CommonJS, ensure you use the correct import style for dependencies.
• ASCII art not displaying? Check your terminal font and width.
• Dynamic fields not showing? Make sure your project is a git repo and env vars are set.

🤝 Contributing

PRs, issues, and suggestions are welcome! Please open an issue or submit a pull request.

📄 License

MIT