{"id":16384643,"url":"https://github.com/nerdic-coder/stencil-cli","last_synced_at":"2025-03-23T03:33:41.700Z","repository":{"id":57101336,"uuid":"135078890","full_name":"nerdic-coder/stencil-cli","owner":"nerdic-coder","description":"A command line interface for StencilJS","archived":false,"fork":false,"pushed_at":"2018-05-29T16:59:36.000Z","size":7,"stargazers_count":16,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-19T13:54:50.979Z","etag":null,"topics":["cli","command-line-tool","node","node-js","nodejs","stencil","stencil-template","stenciljs"],"latest_commit_sha":null,"homepage":null,"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/nerdic-coder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-27T20:21:52.000Z","updated_at":"2021-10-05T14:31:00.000Z","dependencies_parsed_at":"2022-08-20T22:40:28.843Z","dependency_job_id":null,"html_url":"https://github.com/nerdic-coder/stencil-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nerdic-coder%2Fstencil-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nerdic-coder%2Fstencil-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nerdic-coder%2Fstencil-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nerdic-coder%2Fstencil-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nerdic-coder","download_url":"https://codeload.github.com/nerdic-coder/stencil-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221704871,"owners_count":16866847,"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":["cli","command-line-tool","node","node-js","nodejs","stencil","stencil-template","stenciljs"],"created_at":"2024-10-11T04:12:01.532Z","updated_at":"2024-10-28T14:53:49.972Z","avatar_url":"https://github.com/nerdic-coder.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stencil Command Line Interface\nThe unofficial command line interface for StencilJS.\n\n## Installation\n\nStencil requires a recent LTS version of NodeJS and npm. Make sure you've installed and/or updated Node before continuing.\n\nYou can install the Stencil CLI globally with command,\n```bash\nnpm i -g @nerdic-coder/stencil-cli\n```\n\nNow the `stencil` command should be available in your command line tool.\n\n## Usage\n\n### Reusable Components\n\nYou can create a reusable stencil component or library with command,\n```bash\nstencil start-component my-component\n```\n\nWhere `my-component` is the name you want for the component or library.\n\nThis will create a folder with the basics that you need to develop your component.\n\nYou can read more about how to create and publish Stencil components in my article: [How I created and published my first Stencil component](https://nerdic-coder.com/2018/05/27/how-i-created-and-published-my-first-stencil-component/) \n\n### Building an app\n\nYou can build entire apps with Stencil, here is the command to get a starter app for Stencil,\n```bash\nstencil start-app my-app\n```\n\nWhere `my-app` is the name you want for the app.\n\nThis will create a folder with the basics that you need to develop your awesome app.\n\n### Generating a component\n\nWith the following command you can generate a new Stencil component in your exisiting Stencil projects,\n```bash\nstencil generate my-component\n```\n\nWhere `my-component` is the name you want for the new component.\n\nThis will create a new folder for the component under `src/components`, with a css file, unit test spec.ts file and the component tsx file.\n\n### Start development server\n\nThe following command is simply an alias to `npm start` that starts the Stencil development server.\n```bash\nstencil start\n```\n\n### Wildcard command\n\nIf you write any other command after `stencil` it acts like an alias for a npm run script.\n\nFor example `stencil build` will run the `npm run build` command.\n\n## Contribute\n\nIf you see anything that can be improved just let me know or fix it in a pull request. :)\n\n### Development\n\nTo help develop this tool start with cloning it down to your machine and run npm install.\n```bash\ngit clone https://github.com/nerdic-coder/stencil-cli.git stencil-cli\ncd stencil-cli\nnpm install\n```\n\nTo test your local changes run the following in the stencil-cli folder,\n```bash\nnpm link\n```\n\nand now you should be able to run the `stencil` command anywhere and your changes is reflected instantly.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnerdic-coder%2Fstencil-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnerdic-coder%2Fstencil-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnerdic-coder%2Fstencil-cli/lists"}