diff --git a/README.md b/README.md index 1426dc3..b72ef7b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # envui +![Static Badge](https://img.shields.io/badge/node.js-%E2%89%A518-brightgreen) + Beautiful environment variable viewer - A modern alternative to `printenv` ## About envui is a CLI tool that displays environment variables in a clean, readable table format with color highlighting. It's designed to be a more user-friendly alternative to the traditional `printenv` command. +## Requirements + +- Node.js ≥ 18 + ## Installation ```bash @@ -17,17 +23,31 @@ npm install -g @flowernotfound/envui ```bash # Display all environment variables envui +``` +```bash # Prefix filtering (case-insensitive) envui VITE_ envui NODE_ +``` + +Demo output: +![Demo prefix filtering](./assets/demo_prefix.png) + +```bash # Filter by partial match (case-insensitive) envui --filter API envui -f API envui --filter database envui -f database +``` + +Demo output: +![Demo filter functionality](./assets/demo_filter.png) + +```bash # Display help envui --help @@ -35,46 +55,6 @@ envui --help envui --version ``` -## Development - -```bash -# Install dependencies -pnpm install - -# Build the project -pnpm build - -# Run in development mode -pnpm dev - -# Run tests -pnpm test - -# Run tests in watch mode -pnpm test:watch - -# Run tests with coverage -pnpm test:coverage - -# Type checking -pnpm typecheck - -# Lint code -pnpm lint - -# Fix lint issues automatically -pnpm lint:fix - -# Format code -pnpm format - -# Check code formatting -pnpm format:check - -# Clean build artifacts -pnpm clean -``` - ## License -MIT +[MIT license](https://github.com/flowernotfound/envui/blob/master/LICENSE) diff --git a/assets/demo_filter.png b/assets/demo_filter.png new file mode 100644 index 0000000..17caad4 Binary files /dev/null and b/assets/demo_filter.png differ diff --git a/assets/demo_prefix.png b/assets/demo_prefix.png new file mode 100644 index 0000000..9a5e705 Binary files /dev/null and b/assets/demo_prefix.png differ