gitoq is a cli to share env files with high security in minimum time between environments and team members.

🌱 Install

It works with a single command:

npm i -g gitoq

🚀 Quick start

Start the process of synchronizing, managing and deploying your passwords using the Quick Start Guide:

gitoq login

That's it. Now you need to connect your project. Be careful that your project changes every time you run this command.

gitoq connect

After connecting the project we will create an env.gitoq.lock file to track the project. you can commit and push your env.gitoq.lock file safely to a version controller like git.

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

gitoq pull

If you don't have the ENV file, we'll create it for you and monitor your changes. Be careful, if it already exists, we'll change its content. (You can change it before running this command to send your ENV first)

gitoq push

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

👽 Manage Multiple Environments

After you've pushed your ENV file, gitoq automatically sets up your main env. Manage multiple environments with the included UI (learn more) or :

gitoq pull -l

Would you also like to pull your envs to your local workspace? Run the command:

gitoq pull -l

Learn more about usage

📖 Commands

gitoq --help

• login
• logout
• connect
• disconnect
• push
• pull

login

login your gitoq account.

Example:

gitoq login

logout

If you're using multiple devices, make sure to logout 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 the local workspace.

Example:

gitoq disconnect

push

Set changes of local workspace to env.

Example:

gitoq push

FLAGS

-l, --list

Set local workspace changes to preferred env.

gitoq push -l

pull

Get changes of env to local workspace.

Example:

gitoq pull

FLAGS

-l, --list

Get desired env changes to the local workspace.

gitoq pull -l

❓ FAQ

What is my main environment?

It is development by default, but you can change it in the project settings.

What does ENV mean?

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

Should I commit my ENV files?

No. We strongly recommend against committing your env files to version control. It should only include environment-specific values such as database passwords or API keys. Your production database should have a different password than your development database.

Should I commit my env.gitoq.lock file?

Yes sure. It is safe and recommended to do so. It your project identifier.

Contributing

See CONTRIBUTING.md

Changelog

See CHANGELOG.md

License

MIT