Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/becodeorg/cli
⚙️ CLI Utils at BeCode. Useful for everyone.
https://github.com/becodeorg/cli
internal-project tooling
Last synced: 9 days ago
JSON representation
⚙️ CLI Utils at BeCode. Useful for everyone.
- Host: GitHub
- URL: https://github.com/becodeorg/cli
- Owner: becodeorg
- License: mit
- Created: 2018-10-23T07:49:05.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-31T07:19:23.000Z (over 1 year ago)
- Last Synced: 2024-10-30T01:37:46.787Z (15 days ago)
- Topics: internal-project, tooling
- Language: JavaScript
- Homepage:
- Size: 1.57 MB
- Stars: 6
- Watchers: 21
- Forks: 5
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# BeCode: CLI
> ⚙️ CLI Utils at BeCode. Useful for everyone.
* * *
[](https://badge.fury.io/js/%40becode%2Fcli)
[](https://github.com/becodeorg/cli/blob/develop/LICENSE)
[](https://github.com/becodeorg/cli/issues)
* * *
**BeCode CLI** is a command-line based util, with useful tools to automate some of your dev tasks at BeCode.
## About
*Junior* or *Coach*, introducing **BeCode CLI**: a small util tool, giving you some great commands without leaving your terminal.
For 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.
But remember: **BeCode CLI** is *yours*. Feel free to [contribute](./CONTRIBUTING.md), add new features or [requests new ones](https://github.com/becodeorg/cli/issues).
### Use cases
#### Generating docker environment for your projects
The BeCode CLI can generate a `docker-compose.yml` file to handle the dev env for your project.
Simply run `becode generate env` from *inside a git repository* and answer the questions.
You can either install predefined application environment (like **Wordpress**, **Drupal**, **Ghost**…), or build a custom environment, by choosing your main language, your database and tools.
The 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.
#### Generating complete `README.md` template files
The BeCode CLI can generate a `README.md` respecting our [internal guidelines](https://github.com/becodeorg/Central/tree/master/templates/readme).
Simply run `becode generate readme` from *inside a git repository* and answer the questions.
* * *
## Installation
You must have [**node.js**](https://nodejs.org/en/) installed on your machine.
Simply run the following command to install the **BeCode CLI**:
npm install -g @becode/cli
## Usage
The command use this syntax:
becode [command] [args...]
If you need help, use the `help` command:
becode --help
### 🤟 _Recommanded:_ use `npx`
While the command can be a bit longer, it's better to use `npx` instead of installing packages globally.
To do so, instead of using `becode` command, use `npx @becode/cli`:
npx @becode/cli [command] [args...]
### Available commands
#### configure
becode configure
Ask you some questions to setup the cli tool.
Should be run once, possibly right after installing the cli tool.
#### open
becode open [target] [...options]
Open the selected target in your default browser.
##### Available targets
- `central`: open the [Central](https://github.com/becodeorg/Central) repository
- `watch`: open the [Watch](https://github.com/becodeorg/The-Watch) repository
- `promo`: open the repository of your promo - you must have run the command `configure` once before
- `github`: open your GitHub profile (or, if you haven't configured your tool, the GitHub homepage)
- `my` or `mybecode`: open the **MyBeCode** platform
##### Available options
- `-c` `--choose` : Choose promo in a list instead of using the configured one
#### generate
becode generate [target] [...options]
Use interactive process to generate useful files for your projects.
##### Available targets
- `readme`: generate a `README.md` file that conforms with the BeCode's conventions
- `ignore`: generate a common `.gitignore` file
- `env`: generate a **docker compose** env, after some questions
##### Available options
- `-o `, `--output ` : Generate target files at specified path (defaults to current git repo root) - *not supported for the `ignore` target*
## Contribute
Feel free to _hack_ the tool, suggest any modification and/or implement it by yourself and submit a _pull request_ !
The contribution guide is in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
### Any idea? Suggestions?
You don't want (or can't) help, but you have some ideas to improve BeCode CLI?
Please, [create an issue](https://github.com/becodeorg/cli/issues) and tell us everything.
* * *
October 2018, [leny](https://leny.me)@[BeCode](https://becode.org).
Licensed under the [MIT License](./LICENSE).