OSOM CLI! ·

Tired of all the commands I had to write to create a new project and connect it to a new repo, I thought about a solution in the form a "personal cli". And because open source is osom, everyone else can have it an tweak it and whatever you want to do with it.

:dart: Purpose

For now the only thing osom-cli is able to do it to initialize your current working directory as a git repository, create a remote repo and link them together. Osom cli does all the first fetching, pulling/rebase, commit of a new born repository and leaves it ready for you to start working on a fresh new project.

Prerequisites

No prerequisites for installation

:wrench: Installing

Install it with your preffered package manager

npm:

npm install -g osom-cli

yarn:

yarn global add osom-cli

or use it one time with npx:

npx osom-cli osom

Usage

OSOM-CLI uses the Github API to create a remote repository, so a Github Personal Access Token is needed in order to be authorized.

# Go to your preffered directory
mkdir project-name && cd project-name

# Create an .env file and add your Github Personal Access Token. Look at the documentation on personal access tokens provided above.
echo 'GITHUB_PERSONAL_ACCESS_TOKEN=' > .env

# Call osom cli
osom

# Follow de instruction
# 1. Choose a name for your repo
# 2. Write a description (optional)
# 3. Choose if you wan't the repository to be private
# 4. Choose a license for your project
# 5. Enter your username
# 6. Enter your gihtub password. **Enter your Github Personal Access Token here**
# 7. Start working. Enjoy your project.

:open_hands: Contributing

If you would like to contribute please fork this repository. Be my guest to contribute with pull requests or participating on any issue. I'm all into open source so any pull request is much appreciated

If you don't know how to contribute to open source I leave you this link with a medium post written by someone else that walks you through open source github contributions.

:car: Roadmap

|   | Objective | Status | | ----------- | ---------------------- | ------- | | :hourglass: | Continous Delivery | Pending | | :hourglass: | Semantic Versioning | Pending | | :hourglass: | Create react project | Pending | | :hourglass: | Create angular project | Pending | | :hourglass: | Create vue project | Pending |

:eyes: Authors

• Sebastián Linares - @Twitter

License

This project is licensed under the MIT License - see the LICENSE.md file for details