Repository navigation
docs: update README #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,17 @@ | ||
| # envui | ||
|
|
||
|  | ||
|
|
||
| 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,64 +23,38 @@ npm install -g @flowernotfound/envui | |
| ```bash | ||
| # Display all environment variables | ||
| envui | ||
| ``` | ||
|
|
||
| ```bash | ||
| # Prefix filtering (case-insensitive) | ||
| envui VITE_ | ||
| envui NODE_ | ||
| ``` | ||
|
|
||
| Demo output: | ||
|
|
||
|  | ||
|
||
|
|
||
| ```bash | ||
| # Filter by partial match (case-insensitive) | ||
| envui --filter API | ||
| envui -f API | ||
| envui --filter database | ||
| envui -f database | ||
| ``` | ||
|
|
||
| Demo output: | ||
|
|
||
|  | ||
|
||
|
|
||
| ```bash | ||
| # Display help | ||
| envui --help | ||
|
|
||
| # Show version | ||
| 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) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The HTML entity '%E2%89%A5' for the ≥ symbol in the badge URL should be URL-encoded as '%E2%89%A5' or use the literal character '≥'. However, the current encoding appears correct - this may render properly as intended.