mirror of
https://github.com/sbrow/envr.git
synced 2025-12-29 15:47:38 -05:00
docs: Added docs.
This commit is contained in:
57
docs/cli/envr.md
Normal file
57
docs/cli/envr.md
Normal file
@@ -0,0 +1,57 @@
|
||||
## envr
|
||||
|
||||
Manage your .env files.
|
||||
|
||||
### Synopsis
|
||||
|
||||
envr keeps your .env synced to a local, age encrypted database.
|
||||
Is a safe and eay way to gather all your .env files in one place where they can
|
||||
easily be backed by another tool such as restic or git.
|
||||
|
||||
All your data is stored in ~/data.age
|
||||
|
||||
Getting started is easy:
|
||||
|
||||
1. Create your configuration file and set up encrypted storage:
|
||||
|
||||
> envr init
|
||||
|
||||
2. Scan for existing .env files:
|
||||
|
||||
> envr scan
|
||||
|
||||
Select the files you want to back up from the interactive list.
|
||||
|
||||
3. Verify that it worked:
|
||||
|
||||
> envr list
|
||||
|
||||
4. After changing any of your .env files, update the backup with:
|
||||
|
||||
> envr sync
|
||||
|
||||
5. If you lose a repository, after re-cloning the repo into the same path it was
|
||||
at before, restore your backup with:
|
||||
|
||||
> envr restore ~/<path to repository>/.env
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for envr
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr backup](envr_backup.md) - Import a .env file into envr
|
||||
* [envr check](envr_check.md) - Check for missing binaries
|
||||
* [envr edit-config](envr_edit-config.md) - Edit your config with your default editor
|
||||
* [envr init](envr_init.md) - Set up envr
|
||||
* [envr list](envr_list.md) - View your tracked files
|
||||
* [envr nushell-completion](envr_nushell-completion.md) - Generate custom completions for nushell
|
||||
* [envr remove](envr_remove.md) - Remove a .env file from your database
|
||||
* [envr restore](envr_restore.md) - Install a .env file from the database into your file system
|
||||
* [envr scan](envr_scan.md) - Find and select .env files for backup
|
||||
* [envr sync](envr_sync.md) - Update or restore your env backups
|
||||
* [envr version](envr_version.md) - Show envr's version
|
||||
|
||||
18
docs/cli/envr_backup.md
Normal file
18
docs/cli/envr_backup.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr backup
|
||||
|
||||
Import a .env file into envr
|
||||
|
||||
```
|
||||
envr backup <path> [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for backup
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
24
docs/cli/envr_check.md
Normal file
24
docs/cli/envr_check.md
Normal file
@@ -0,0 +1,24 @@
|
||||
## envr check
|
||||
|
||||
Check for missing binaries
|
||||
|
||||
### Synopsis
|
||||
|
||||
envr relies on external binaries for certain functionality.
|
||||
|
||||
The check command reports on which binaries are available and which are not.
|
||||
|
||||
```
|
||||
envr check [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for check
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
18
docs/cli/envr_edit-config.md
Normal file
18
docs/cli/envr_edit-config.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr edit-config
|
||||
|
||||
Edit your config with your default editor
|
||||
|
||||
```
|
||||
envr edit-config [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for edit-config
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
27
docs/cli/envr_init.md
Normal file
27
docs/cli/envr_init.md
Normal file
@@ -0,0 +1,27 @@
|
||||
## envr init
|
||||
|
||||
Set up envr
|
||||
|
||||
### Synopsis
|
||||
|
||||
The init command generates your initial config and saves it to
|
||||
~/.envr/config in JSON format.
|
||||
|
||||
During setup, you will be prompted to select one or more ssh keys with which to
|
||||
encrypt your databse. **Make 100% sure** that you have **a remote copy** of this
|
||||
key somewhere, otherwise your data could be lost forever.
|
||||
|
||||
```
|
||||
envr init
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for init
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
18
docs/cli/envr_list.md
Normal file
18
docs/cli/envr_list.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr list
|
||||
|
||||
View your tracked files
|
||||
|
||||
```
|
||||
envr list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
23
docs/cli/envr_nushell-completion.md
Normal file
23
docs/cli/envr_nushell-completion.md
Normal file
@@ -0,0 +1,23 @@
|
||||
## envr nushell-completion
|
||||
|
||||
Generate custom completions for nushell
|
||||
|
||||
### Synopsis
|
||||
|
||||
At time of writing, cobra does not natively support nushell,
|
||||
so a custom command had to be written
|
||||
|
||||
```
|
||||
envr nushell-completion [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for nushell-completion
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
18
docs/cli/envr_remove.md
Normal file
18
docs/cli/envr_remove.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr remove
|
||||
|
||||
Remove a .env file from your database
|
||||
|
||||
```
|
||||
envr remove [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for remove
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
18
docs/cli/envr_restore.md
Normal file
18
docs/cli/envr_restore.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr restore
|
||||
|
||||
Install a .env file from the database into your file system
|
||||
|
||||
```
|
||||
envr restore [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for restore
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
18
docs/cli/envr_scan.md
Normal file
18
docs/cli/envr_scan.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr scan
|
||||
|
||||
Find and select .env files for backup
|
||||
|
||||
```
|
||||
envr scan [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for scan
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
18
docs/cli/envr_sync.md
Normal file
18
docs/cli/envr_sync.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## envr sync
|
||||
|
||||
Update or restore your env backups
|
||||
|
||||
```
|
||||
envr sync [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for sync
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
19
docs/cli/envr_version.md
Normal file
19
docs/cli/envr_version.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## envr version
|
||||
|
||||
Show envr's version
|
||||
|
||||
```
|
||||
envr version [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for version
|
||||
-l, --long Show all version information
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
Reference in New Issue
Block a user