organizejs-cli v1.0.0

en | pt-BR

This project aims to make your life easier when creating and interacting with your JavaScript projects. Among its main features are:

• create the directory and start the JavaScript project;
• open any project anywhere on your machine using your favorite IDE...

For now it's pretty simple, but there's more to come...

Installation

Use npm or yarn:

npm install --global organizejs-cli

or

yarn global add organizejs-cli

Getting Started

First of all you need to create a user, use the command below:

organize new:user name password

When creating a user, it is already defined as active on your machine, to understand it better click here.

Now you can start creating your projects. Navigate to the directory where you want to create the project and run the command below (this command automatically creates the project folder with the name that was defined).

organize new:project project_name

Now you can use the command open to open the project in your IDE. I recommend that you check the command to avoid any errors.

organize open project_name

See about commands to better understand how the CLI works.

new:user

This command is responsible to create new users. You need to set your username and password (It's possible to create many users). When the user is created it is set to active.

organize new:user <username> <password>

OPTIONS:

-h, --help - display help for command.

list:user

This command is responsible for listing all the users you have created.

organize list:user

OPTIONS:

-u, --user <username> - return a specific user according to the given username.

-h, --help - display help for command.

set:active

Since more than one user can be created on your machine, you can define which user is the active one. The active user is the one executing the commands, so if you list or open projects, the CLI will look for the active user's projects. The same goes for creating projects. So it's important verify which user is the active, you can see this by listing the users.

This command is responsible for changing the active user.

organize set:active <username>

OPTIONS:

-h, --help - display help for command.

new:project

This command is responsible for creating new projects for an active user. Just navigate to the directory you want to create the project and run the command below.

organize new:project <name>

OPTIONS:

-h, --help - display help for command.

list:project

This command is responsible for listing all projects of the active user.

organize list:project

OPTIONS:

-n, --name <projectName> - return a specific project according to the given name.

-h, --help - display help for command.

open | o

This command is responsible for opening the projects in your IDE. By default, the CLI uses VScode (code), but you can change it. You can run this command from any directory on your machine.

organize open <projectName>

or

organize o <projectName>

OPTIONS:

-i, --ide <ideCLI> - Change the IDE for open your projects. (default: "code")

-h, --help - display help for command.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lucas Suares - suares_silva.01@hotmail.com