{"id":13570756,"url":"https://github.com/becodeorg/cli","last_synced_at":"2025-07-30T11:07:51.194Z","repository":{"id":33660500,"uuid":"154285542","full_name":"becodeorg/cli","owner":"becodeorg","description":"⚙️ CLI Utils at BeCode. Useful for everyone.","archived":false,"fork":false,"pushed_at":"2023-07-31T07:19:23.000Z","size":1648,"stargazers_count":6,"open_issues_count":25,"forks_count":5,"subscribers_count":21,"default_branch":"develop","last_synced_at":"2024-12-22T03:13:18.271Z","etag":null,"topics":["internal-project","tooling"],"latest_commit_sha":null,"homepage":"","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/becodeorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2018-10-23T07:49:05.000Z","updated_at":"2024-10-16T08:00:10.000Z","dependencies_parsed_at":"2024-10-30T00:03:27.267Z","dependency_job_id":null,"html_url":"https://github.com/becodeorg/cli","commit_stats":{"total_commits":256,"total_committers":10,"mean_commits":25.6,"dds":0.47265625,"last_synced_commit":"dce874cd4e05f06d9c46506ab96cfa467feab731"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/becodeorg%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/becodeorg%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/becodeorg%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/becodeorg%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/becodeorg","download_url":"https://codeload.github.com/becodeorg/cli/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232143441,"owners_count":18478575,"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":["internal-project","tooling"],"created_at":"2024-08-01T14:00:54.760Z","updated_at":"2025-01-03T07:23:55.123Z","avatar_url":"https://github.com/becodeorg.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# BeCode: CLI\n\n\u003e ⚙️ CLI Utils at BeCode. Useful for everyone.\n\n* * *\n\n[![npm version](https://badge.fury.io/js/%40becode%2Fcli.svg)](https://badge.fury.io/js/%40becode%2Fcli)\n[![License: MIT](https://img.shields.io/github/license/becodeorg/cli.svg)](https://github.com/becodeorg/cli/blob/develop/LICENSE)\n[![GitHub Issues](https://img.shields.io/github/issues/becodeorg/cli.svg)](https://github.com/becodeorg/cli/issues)\n\n* * *\n\n**BeCode CLI** is a command-line based util, with useful tools to automate some of your dev tasks at BeCode.\n\n## About\n\n*Junior* or *Coach*, introducing **BeCode CLI**: a small util tool, giving you some great commands without leaving your terminal.  \nFor now, this tool allows you to navigate to our different GitHub repositories, generate complete *docker dev environments* or generate `README.md` files according to BeCode standards.\n\nBut remember: **BeCode CLI** is *yours*. Feel free to [contribute](./CONTRIBUTING.md), add new features or [requests new ones](https://github.com/becodeorg/cli/issues).\n\n### Use cases\n\n#### Generating docker environment for your projects\n\nThe BeCode CLI can generate a `docker-compose.yml` file to handle the dev env for your project.  \nSimply run `becode generate env` from *inside a git repository* and answer the questions.\n\nYou can either install predefined application environment (like **Wordpress**, **Drupal**, **Ghost**…), or build a custom environment, by choosing your main language, your database and tools.\n\nThe BeCode CLI will generate two files: a complete, *ready-to-use* `docker-compose.yml` file ; and a `docker-readme.md` file, containing all the information about docker (how to install and configure), and the containers of your app.\n\n#### Generating complete `README.md` template files\n\nThe BeCode CLI can generate a `README.md` respecting our [internal guidelines](https://github.com/becodeorg/Central/tree/master/templates/readme).\n\nSimply run `becode generate readme` from *inside a git repository* and answer the questions.\n\n* * *\n\n## Installation\n\nYou must have [**node.js**](https://nodejs.org/en/) installed on your machine.\n\nSimply run the following command to install the **BeCode CLI**:\n\n\tnpm install -g @becode/cli\n\n## Usage\n\nThe command use this syntax:\n\n    becode [command] [args...]\n\nIf you need help, use the `help` command:\n\n    becode --help\n    \n### 🤟 _Recommanded:_ use `npx`\n\nWhile the command can be a bit longer, it's better to use `npx` instead of installing packages globally.\n\nTo do so, instead of using `becode` command, use `npx @becode/cli`:\n\n\tnpx @becode/cli [command] [args...]\n\n### Available commands\n\n#### configure\n\n    becode configure\n\nAsk you some questions to setup the cli tool.  \nShould be run once, possibly right after installing the cli tool.\n\n#### open\n\n    becode open [target] [...options]\n\nOpen the selected target in your default browser.\n\n##### Available targets\n\n- `central`: open the [Central](https://github.com/becodeorg/Central) repository\n- `watch`: open the [Watch](https://github.com/becodeorg/The-Watch) repository\n- `promo`: open the repository of your promo - you must have run the command `configure` once before\n- `github`: open your GitHub profile (or, if you haven't configured your tool, the GitHub homepage)\n- `my` or `mybecode`: open the **MyBeCode** platform\n\n##### Available options\n\n- `-c` `--choose` : Choose promo in a list instead of using the configured one\n\n#### generate\n\n    becode generate [target] [...options]\n\nUse interactive process to generate useful files for your projects.\n\n##### Available targets\n\n- `readme`: generate a `README.md` file that conforms with the BeCode's conventions\n- `ignore`: generate a common `.gitignore` file\n- `env`: generate a **docker compose** env, after some questions\n\n##### Available options\n\n- `-o  \u003cpath\u003e`, `--output \u003cpath\u003e` : Generate target files at specified path (defaults to current git repo root) - *not supported for the `ignore` target*\n\n## Contribute\n\nFeel free to _hack_ the tool, suggest any modification and/or implement it by yourself and submit a _pull request_ !\n\nThe contribution guide is in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n\n### Any idea? Suggestions?\n\nYou don't want (or can't) help, but you have some ideas to improve BeCode CLI?  \nPlease, [create an issue](https://github.com/becodeorg/cli/issues) and tell us everything.\n\n* * *\n\nOctober 2018, [leny](https://leny.me)@[BeCode](https://becode.org).\nLicensed under the [MIT License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbecodeorg%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbecodeorg%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbecodeorg%2Fcli/lists"}