{"id":49896431,"url":"https://github.com/oharu121/cli-ascii-logo","last_synced_at":"2026-05-16T00:10:39.236Z","repository":{"id":323185553,"uuid":"1092409458","full_name":"oharu121/cli-ascii-logo","owner":"oharu121","description":"Create beautiful ASCII art logos with gradient colors for your CLI applications.","archived":false,"fork":false,"pushed_at":"2026-05-12T05:05:51.000Z","size":461,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-12T07:09:48.212Z","etag":null,"topics":["ascii","ascii-art","banner","cli","cli-tool","figlet","gradient","logo","terminal"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/cli-ascii-logo","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oharu121.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-08T15:22:08.000Z","updated_at":"2026-05-12T05:05:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/oharu121/cli-ascii-logo","commit_stats":null,"previous_names":["oharu121/cli-ascii-logo"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/oharu121/cli-ascii-logo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oharu121%2Fcli-ascii-logo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oharu121%2Fcli-ascii-logo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oharu121%2Fcli-ascii-logo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oharu121%2Fcli-ascii-logo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oharu121","download_url":"https://codeload.github.com/oharu121/cli-ascii-logo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oharu121%2Fcli-ascii-logo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33085198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T20:25:35.270Z","status":"ssl_error","status_checked_at":"2026-05-15T20:25:34.732Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii","ascii-art","banner","cli","cli-tool","figlet","gradient","logo","terminal"],"created_at":"2026-05-16T00:10:31.102Z","updated_at":"2026-05-16T00:10:39.230Z","avatar_url":"https://github.com/oharu121.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CLI ASCII Logo\n\n[![npm version](https://badge.fury.io/js/cli-ascii-logo.svg)](https://badge.fury.io/js/cli-ascii-logo)\n![License](https://img.shields.io/npm/l/cli-ascii-logo)\n![Types](https://img.shields.io/npm/types/cli-ascii-logo)\n![NPM Downloads](https://img.shields.io/npm/dw/cli-ascii-logo)\n![Last Commit](https://img.shields.io/github/last-commit/oharu121/cli-ascii-logo)\n![GitHub Stars](https://img.shields.io/github/stars/oharu121/cli-ascii-logo?style=social)\n\nCreate beautiful ASCII art logos with gradient colors for your CLI applications.\n\n## Installation\n\n```bash\npnpm add cli-ascii-logo\n```\n\n\u003e **Note:** Version 2.1.0+ uses ES modules (ESM). If you need CommonJS support, use version 2.0.x or earlier.\n\n## Usage\n\n### CLI Usage\n\nUse directly with npx (no installation required):\n\n```bash\nnpx cli-ascii-logo \"Hello World\"\n```\n\nOr install globally:\n\n```bash\npnpm add -g cli-ascii-logo\ncli-ascii-logo \"My App\"\n```\n\n#### CLI Options\n\n```bash\n# Basic usage with default gradient (sunset)\ncli-ascii-logo \"Hello World\"\n\n# Use a specific gradient palette\ncli-ascii-logo \"Hello World\" --palette cyberpunk\ncli-ascii-logo \"Hello World\" -p ocean\n\n# Use a random gradient\ncli-ascii-logo \"Hello World\" --random\ncli-ascii-logo \"Hello World\" -r\n\n# List all available palettes\ncli-ascii-logo --list\ncli-ascii-logo -l\n\n# Show help\ncli-ascii-logo --help\ncli-ascii-logo -h\n```\n\n#### CLI Examples\n\n```bash\n# Create a logo with the sunset gradient\nnpx cli-ascii-logo \"MyApp\"\n\n# Create a logo with cyberpunk theme\nnpx cli-ascii-logo \"CLI Tool\" -p cyberpunk\n\n# Generate with random colors\nnpx cli-ascii-logo \"Surprise\" --random\n\n# See all available gradient options\nnpx cli-ascii-logo --list\n```\n\n### Programmatic Usage\n\n## Quick Start\n\n```typescript\nimport logo from \"cli-ascii-logo\";\n\n// Simple usage with default gradient\nconsole.log(logo.createLogo(\"Hello\"));\n\n// Use a specific gradient\nconsole.log(logo.createLogo(\"My App\", \"rainbow\"));\n\n// Random gradient\nconsole.log(logo.createRandomLogo(\"Surprise!\"));\n```\n\n## API Reference\n\n### Simple Methods\n\n#### `createLogo(text: string, palette?: PaletteName): string`\n\nCreate a logo with a single call.\n\n```typescript\nlogo.createLogo(\"MyApp\", \"sunset\");\n```\n\n#### `createRandomLogo(text: string): string`\n\nCreate a logo with a random gradient palette.\n\n```typescript\nlogo.createRandomLogo(\"Lucky\");\n```\n\n### Builder Pattern (Advanced)\n\nFor more control, use the fluent builder API:\n\n```typescript\nlogo.setText(\"MyApp\").addFontStyle(\"ANSI Shadow\", 120).build(\"ocean\");\n```\n\n#### Methods\n\n- **`setText(text: string): this`** - Set the text for the logo\n- **`addFontStyle(font?: figlet.Fonts, width?: number): this`** - Apply ASCII art font\n- **`build(palette?: PaletteName): string`** - Build and return the final logo\n- **`addGradient(palette: PaletteName): string`** - Apply gradient and return (alternative to build)\n- **`addRandomGradient(): string`** - Apply random gradient and return\n\n## Available Gradients\n\n### Custom Gradients\n\n**Classic \u0026 Popular:**\n\n- `sunset` - Warm orange to red (default)\n- `ocean` - Deep blue to purple\n- `fire` - Bold red to pink\n- `forest` - Teal to green\n- `gold` - Orange to yellow\n- `copper` - Metallic bronze\n\n![Popular Gradients](./assets/popular-gradients.png)\n\n**Cool Tones:**\n\n- `blue` - Bright blue gradient\n- `mint` - Cyan to blue\n- `aqua` - Turquoise tones\n- `ice` - Icy white-blue tones\n\n![Cool Gradients](./assets/cool-gradients.png)\n\n**Warm Tones:**\n\n- `lava` - Hot reds and oranges\n- `volcano` - Dark red to gold\n- `coral` - Soft pink gradient\n- `cherry` - Pink-red\n\n![Warm Gradients](./assets/warm-gradients.png)\n\n**Vibrant \u0026 Modern:**\n\n- `cyberpunk` - Neon pink-cyan\n- `neon` - Radioactive green\n- `aurora` - Northern lights effect\n- `lavender` - Soft purples\n- `emerald` - Northern lights effect\n\n![Vibrant Gradients](./assets/vibrant-gradients.png)\n\n**Special Effects:**\n\n- `matrix` - Classic terminal green\n- `nebula` - Purple to pink space\n\n![Special Gradients](./assets/special-gradients.png)\n\n### Preset Gradients\n\nFrom the `gradient-string` library: `cristal`, `teen`, `mind`, `morning`, `vice`, `passion`, `fruit`, `instagram`, `atlas`, `retro`, `summer`, `pastel`, `rainbow`\n\nYou can get the list programmatically:\n\n```typescript\nimport { PALETTE_NAMES } from \"cli-ascii-logo\";\n\nconsole.log(PALETTE_NAMES); // Array of all available palette names\n```\n\n## TypeScript Support\n\nFull TypeScript support with exported types:\n\n```typescript\nimport logo, {\n  PaletteName,\n  PALETTE_NAMES,\n  CUSTOM_GRADIENTS,\n} from \"cli-ascii-logo\";\n\nconst palette: PaletteName = \"sunset\";\n```\n\n## Examples\n\n### Basic Example\n\n```typescript\nimport logo from \"cli-ascii-logo\";\n\nconsole.log(logo.createLogo(\"Welcome\", \"rainbow\"));\n```\n\n### Builder Pattern Example\n\n```typescript\nimport logo from \"cli-ascii-logo\";\n\nconst myLogo = logo.setText(\"MyApp\").addFontStyle(\"ANSI Shadow\").build(\"ocean\");\n\nconsole.log(myLogo);\n```\n\n### Show All Palettes\n\n```typescript\nimport logo, { PALETTE_NAMES } from \"cli-ascii-logo\";\n\nPALETTE_NAMES.forEach((palette) =\u003e {\n  console.log(`\\n--- ${palette} ---`);\n  console.log(logo.createLogo(\"Logo\", palette));\n});\n```\n\n### Rich Application Banner\n\nCreate a full banner with metadata (version, timestamp, etc.):\n\n```typescript\nimport logo from \"cli-ascii-logo\";\nimport fs from \"fs\";\n\nfunction printAppBanner() {\n  const pkg = JSON.parse(fs.readFileSync(\"./package.json\", \"utf-8\"));\n  const logoText = logo.createLogo(\"wonderful\\napp\", \"cyberpunk\");\n\n  const banner = [\n    \"=\".repeat(80),\n    logoText,\n    `Version: ${pkg.version}`,\n    `Started: ${new Date().toLocaleString()}`,\n    \"=\".repeat(80),\n  ].join(\"\\n\");\n\n  console.log(banner);\n}\n\nprintAppBanner();\n```\n\n![Banner with Meta](./assets/banner-with-meta.png)\n\nYou can also apply gradients to the entire banner:\n\n```typescript\nfunction printColoredBanner() {\n  const pkg = JSON.parse(fs.readFileSync(\"./package.json\", \"utf-8\"));\n  const logoText = logo.setText(\"wonderful\\napp\").addFontStyle().getText();\n\n  const bannerText = [\n    \"=\".repeat(80),\n    logoText,\n    `Version: ${pkg.version}`,\n    `Started: ${new Date().toLocaleString()}`,\n    \"=\".repeat(80),\n  ].join(\"\\n\");\n\n  // Apply gradient to the entire banner\n  console.log(logo.setText(bannerText).addRandomGradient());\n}\n\nprintColoredBanner();\n```\n\n![Entire Banner Gradiented](./assets/entire-banner-gradiented.png)\n\n## Advanced Features\n\n### Animation Support\n\nDisplay logos with animations:\n\n```typescript\nimport logo from 'cli-ascii-logo';\n\n// Display with fade-in animation\nawait logo.setText('MyApp').addFontStyle().display({\n  gradient: 'cyberpunk',\n  animation: 'fade-in',\n  duration: 2000,\n  clearBefore: true,\n});\n\n// Other animation types: 'slide-in', 'typing'\nawait logo.setText('Hello').addFontStyle().display({\n  animation: 'typing',\n  duration: 1500,\n});\n```\n\n## Development\n\n### Running Tests\n\n```bash\n# Run all tests\npnpm test\n\n# Run tests in watch mode\npnpm run test:watch\n\n# Run tests with UI\npnpm run test:ui\n\n# Generate coverage report\npnpm run test:coverage\n```\n\n### Code Quality\n\n```bash\n# Lint code\npnpm run lint\n\n# Auto-fix linting issues\npnpm run lint:fix\n\n# Format code with Prettier\npnpm run format\n\n# Check formatting\npnpm run format:check\n```\n\n### Building\n\n```bash\n# Build TypeScript to dist/\npnpm run build\n```\n\n## Dependencies\n\n- [figlet](https://www.npmjs.com/package/figlet) - ASCII art text generation\n- [gradient-string](https://www.npmjs.com/package/gradient-string) - Gradient color effects\n\n## Dev Dependencies\n\n- TypeScript 5.3+\n- Vitest for testing\n- ESLint 9 with flat config\n- Prettier for code formatting\n\n## Requirements\n\n- Node.js \u003e= 14.0.0\n- ES Module support (ESM)\n\n## License\n\nMIT\n\n## Contributing\n\nContributions welcome! Please ensure:\n\n1. All tests pass (`pnpm test`)\n2. Code is linted (`pnpm run lint`)\n3. Code is formatted (`pnpm run format`)\n4. Add tests for new features\n\nOpen an issue or PR on GitHub.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foharu121%2Fcli-ascii-logo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foharu121%2Fcli-ascii-logo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foharu121%2Fcli-ascii-logo/lists"}