{"id":16070743,"url":"https://github.com/cjpatoilo/banner-cli","last_synced_at":"2026-03-17T01:47:14.033Z","repository":{"id":74716330,"uuid":"75224809","full_name":"cjpatoilo/banner-cli","owner":"cjpatoilo","description":"Create a banner comment from package data.","archived":false,"fork":false,"pushed_at":"2023-02-27T01:21:13.000Z","size":508,"stargazers_count":54,"open_issues_count":4,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-27T05:51:31.823Z","etag":null,"topics":["banner","banner-comment","cli","npm"],"latest_commit_sha":null,"homepage":"https://cjpatoilo.com/banner-cli","language":"JavaScript","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/cjpatoilo.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":".github/contributing.md","funding":".github/funding.yml","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},"funding":{"open_collective":"cjpatoilo","patreon":"cjpatoilo"}},"created_at":"2016-11-30T20:33:48.000Z","updated_at":"2024-12-30T15:51:37.000Z","dependencies_parsed_at":"2024-01-14T02:37:02.463Z","dependency_job_id":"cb00fb07-4730-4963-a5e2-20bb690516d1","html_url":"https://github.com/cjpatoilo/banner-cli","commit_stats":{"total_commits":92,"total_committers":3,"mean_commits":"30.666666666666668","dds":0.04347826086956519,"last_synced_commit":"c8d7062f8325ec2c062d2d670d162b901b308f12"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjpatoilo%2Fbanner-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjpatoilo%2Fbanner-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjpatoilo%2Fbanner-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cjpatoilo%2Fbanner-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cjpatoilo","download_url":"https://codeload.github.com/cjpatoilo/banner-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243806070,"owners_count":20350775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["banner","banner-comment","cli","npm"],"created_at":"2024-10-09T07:06:54.787Z","updated_at":"2026-03-17T01:47:08.989Z","avatar_url":"https://github.com/cjpatoilo.png","language":"JavaScript","funding_links":["https://opencollective.com/cjpatoilo","https://patreon.com/cjpatoilo"],"categories":["Javascript"],"sub_categories":["Node.js"],"readme":"\u003ca href=\"https://github.com/cjpatoilo/banner-cli\"\u003e\u003cimg width=\"100%\" src=\"https://cjpatoilo.com/banner-cli/artwork.png\" alt=\"BannerCLI - Create a banner comment from package data.\"\u003e\u003c/a\u003e\n\n\u003e Create a banner comment from package data.\n\n[![Travis Status](https://travis-ci.org/cjpatoilo/banner-cli.svg?branch=master)](https://travis-ci.org/cjpatoilo/banner-cli?branch=master)\n[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/efthn2yp6c57gu1b?svg=true)](https://ci.appveyor.com/project/cjpatoilo/banner-cli)\n[![Codacy Status](https://img.shields.io/codacy/grade/848fb4bd6902434fab0bcfb5461284fe/master.svg)](https://www.codacy.com/app/cjpatoilo/banner-cli/dashboard)\n[![Dependencies Status](https://david-dm.org/cjpatoilo/banner-cli/status.svg)](https://david-dm.org/cjpatoilo/banner-cli)\n[![Version Status](https://badge.fury.io/js/banner-cli.svg)](https://www.npmjs.com/package/banner-cli)\n[![Download Status](https://img.shields.io/npm/dt/banner-cli.svg)](https://www.npmjs.com/package/banner-cli)\n[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/banner-cli)\n\n## Why it's awesome\n\nA command line interface to add relevant information to your source code from package data. This lib reads the `package.json` files, then a banner is generated based on each of these values: `name`, `version`, `homepage`, `year`, `author` and `license`.\n\n## Getting Started\n\n**Install with npm**\n\n```bash\n$ npm install banner-cli\n```\n\n**Install with Yarn**\n\n```bash\n$ yarn add banner-cli\n```\n\nRun with npx (without installing)\n\n```bash\n$ npx banner-cli\n```\n\n_Note: Install this npm package with `-g` to global use or with `-D` to add the package as a devDependency in the `package.json` file of your project._\n\n## Usage\n\n_Note: Glob support is truth. Find files using the patterns the shell uses, like stars and stuff._\n\n```bash\n$ banner-cli dist/**/*.css\n```\n\nfrom `package.json` data:\n\n```json\n{\n  \"name\": \"milligram\",\n  \"version\": \"1.4.0\",\n  \"homepage\": \"https://milligram.io\",\n  \"license\": \"MIT\",\n  \"author\": \"CJ Patoilo \u003ccjpatoilo@gmail.com\u003e\"\n}\n```\n\nto add a banner comment:\n\n```js\n/*!\n * Milligram v1.4.0\n * https://milligram.io\n *\n * Copyright (c) 2020 CJ Patoilo\n * Licensed under the MIT license\n */\n```\n\n## CLI\n\n```bash\n$ banner-cli --help\n\n  Usage:\n\n    $ banner-cli \u003cfiles\u003e [\u003coptions\u003e]\n\n  Options:\n\n    -n, --name              Define project name\n    -t, --tag               Define tag version\n    -s, --site              Define homepage\n    -a, --author            Define author\n    -y, --year              Define year\n    -l, --license           Define license\n    -h, --help              Display help information\n    -v, --version           Output version\n\n  Examples:\n\n    $ banner-cli dist/**/*.js\n    $ banner-cli dist/**/*.css --author 'CJ Patoilo' --license MIT --site https://milligram.io\n\n```\n\n## Contributing\n\nWant to contribute? Follow these [recommendations](https://github.com/cjpatoilo/banner-cli/contribute).\n\n## License\n\nDesigned with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://cjpatoilo.com/license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcjpatoilo%2Fbanner-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcjpatoilo%2Fbanner-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcjpatoilo%2Fbanner-cli/lists"}