Documents

🌱 Install

First, you need to install the necessary libraries for your application.

#works with a single command$npm i -g gitoq

🚀 Quick start

Next, you will log into your account:

#login your gitoq account$gitoq login

Well done. Now, you need to connect your project. Be aware that each time you run this command, your project will change.

#connect your project to your local workspace$gitoq connect

After connecting the project, we will create an env.gitoq.lock file to track the project. You can safely commit and push this file to a version control system like git.

Now you can get the latest changes of your main environment (by default development):

#get changes of env to local workspace$gitoq pull

If you don’t have the ENV file, we’ll create it for you and monitor your changes. Note that if it already exists, we will modify its contents. (You can commit your ENV changes before running this command.)

#set changes of local workspace to env$gitoq push

⭐ Note: Our intention regarding the ENV file is either the .env or .env.local. We will create one of them based on their presence in your source code (priority is given to .env).

👽 Manage Multiple Environments

After pushing your ENV file, gitoq will automatically set it up for your default environment. You can manage your environments using the following command:

#set local workspace changes to preferred env$gitoq push -l

To pull your environments to your local workspace, you can also use the following command:

#get desired env changes to the local workspace$gitoq pull -l

📖 Commands

$gitoq --help

login

Log into your gitoq account.

Example:

$gitoq login

logout

If you are using a public device, make sure to log out to protect your privacy.

Example:

$gitoq logout

connect

Connect your project to your local workspace.

Example:

$gitoq connect

Arguments

[Token] : Connect your project directly to your local workspace.

$gitoq connect Token

disconnect

Cancel access to the project from your local workspace.

Example:

$gitoq disconnect

push

Send changes from the local workspace to the environment.

Example:

$gitoq push

Flags

-l, --list : Send local workspace changes to the preferred environment.

$gitoq push -l

pull

Get changes from the environment to your local workspace.

Example:

$gitoq pull

Flags

-l, --list : Get changes from the desired environment to your local workspace.

$gitoq pull -l

If you have any questions, please visit the FAQ page.