Clippium

Command Line Interface with Powerful and Pristine Operations

Table of contents

• What is clippium?
• Features
• Usage
  • Simple usage
  • Module usage example
• 🔑 Installation
• ➕ More
• 👨‍💻 Development
• ❤️ Donate
• 📜 License
• ✨ About us

What is clippium?

clippium is a tool that helps to create command line interfaces (CLI) with powerful and pristine operations.

ℹ️ The first version is now available. Feel free to report any issues here

Features

• 🚀 Easy to Use: Simple setup with minimal configuration required.

• ⚡ Fast: Optimized for quick execution and minimal overhead. Read more

• 📦 lightweight: Zero dependencies and a small package

• 🌍 Available for:

  • 🟢 Node.js
  • 🦕 Deno
  • 🍞 Bun
  • 🌐 Browser

• 🛠️ Customizable:

  • Change the help format, version, and error output.
  • Create style themes for your CLIs.

• 🎨 Presets:

  • Colored: Add color to help output.
  • Default: Add standard flags like --help or --version.
  • Config: Add configuration file support.

• Toolkit:

  • A CLI toolkit to initialize, convert, transform, and create documentation for your Clippium CLI. Read more

• Extra tools:

  • Color: Add color support to your text (with browser support).
  • i18n: Add Internalization to your CLI (with browser support).
  • Updater: Add updater notification to your CLI.

Usage

Simple usage

import { Clippium } from 'clippium'

const cli = new Clippium( data )
cli.fn = async data => {
  // do something
}
await cli.run( process.argv.slice( 2 ) )

Module usage example

import process from 'node:process'
import { hideBin, defineData, parse } from 'clippium'

const data = defineData({ ... })
const argv = hideBin( process.argv )

const { 
	flags, 
	positionals, 
	commands 
} = parse( {argv, data} )

// do something

🔑 Installation

npm install clippium
# or
pnpm install clippium
# or
yarn add clippium
# or
bun add clippium
# or
deno add clippium

➕ More

• 🌞 Core
• 📝 Schema
• 🧰 Toolkit
• 🎨 Color
• 🌐 I18n
• 📦 Updater
• 💾 Preset
  • 🖼️ Colored
  • ⚙️ Config
  • ➡️ Default

👨‍💻 Development

clippium is an open-source project and its development is open to anyone who wants to participate.

❤️ Donate

Help us to develop more interesting things.

📜 License

This software is licensed with MIT.

✨ About us

PigeonPosse is a code development collective focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

Contributors

| | Name | Role | | ----- | ---- | ---- | | | Angelo | 👑 Author | | | PigeonPosse | 🏢 Organization |