mirror of
https://github.com/sbrow/envr.git
synced 2026-08-26 09:53:32 -04:00
feat: Brought back the docs generator.
This commit is contained in:
+11
-10
@@ -5,7 +5,7 @@ Manage your .env files.
|
||||
### Synopsis
|
||||
|
||||
envr keeps your .env synced to a local, encrypted database.
|
||||
Is a safe and eay way to gather all your .env files in one place where they can
|
||||
Is a safe and easy 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 ~/.envr/data.envr
|
||||
@@ -33,25 +33,26 @@ Select the files you want to back up from the interactive list.
|
||||
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
|
||||
> envr restore ~/<path to repository>/.env
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for envr
|
||||
-h, --help show this documentation
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr backup](envr_backup.md) - Import a .env file into envr
|
||||
* [envr check](envr_check.md) - check if files in the current directory are backed up
|
||||
* [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 backup](envr_backup.md) - Import a .env file into envr
|
||||
* [envr restore](envr_restore.md) - Restore a .env file from the database
|
||||
* [envr list](envr_list.md) - View your tracked files
|
||||
* [envr remove](envr_remove.md) - Remove a .env file from your database
|
||||
* [envr check](envr_check.md) - Check if files are backed up
|
||||
* [envr version](envr_version.md) - Show envr's version
|
||||
* [envr edit-config](envr_edit-config.md) - Edit your config with your default editor
|
||||
* [envr completion](envr_completion.md) - Generate shell completion scripts
|
||||
* [envr uninstall](envr_uninstall.md) - Remove envr configuration and database
|
||||
|
||||
|
||||
@@ -6,13 +6,20 @@ Import a .env file into envr
|
||||
envr backup <path> [flags]
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `path` — Path to .env file to backup
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for backup
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
*Alias: `add`*
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -1,18 +1,23 @@
|
||||
## envr check
|
||||
|
||||
check if files in the current directory are backed up
|
||||
Check if files are backed up
|
||||
|
||||
```
|
||||
envr check [path] [flags]
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `path` — Path to check (defaults to current directory) (optional)
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for check
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
## envr completion
|
||||
|
||||
Generate shell completion scripts
|
||||
|
||||
### Synopsis
|
||||
|
||||
Supported shells:
|
||||
|
||||
nushell
|
||||
bash
|
||||
|
||||
```
|
||||
envr completion <shell> [flags]
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `shell` — Shell to generate completions for
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help show this documentation
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
@@ -9,10 +9,11 @@ envr edit-config [flags]
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for edit-config
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -5,9 +5,7 @@ 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
|
||||
~/.envr/config in JSON format.\n\nDuring 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.
|
||||
|
||||
@@ -18,11 +16,12 @@ envr init [flags]
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --force Overwrite an existing config
|
||||
-h, --help help for init
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
-f, --force Overwrite existing config
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -9,10 +9,12 @@ envr list [flags]
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
-o, --output the format of output data (default 'table')
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
## 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.
|
||||
|
||||
@@ -3,16 +3,21 @@
|
||||
Remove a .env file from your database
|
||||
|
||||
```
|
||||
envr remove [flags]
|
||||
envr remove <path> [flags]
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `path` — Path to .env file to remove
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for remove
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -1,18 +1,23 @@
|
||||
## envr restore
|
||||
|
||||
Install a .env file from the database into your file system
|
||||
Restore a .env file from the database
|
||||
|
||||
```
|
||||
envr restore [flags]
|
||||
envr restore <path> [flags]
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `path` — Path to .env file to restore
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for restore
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -9,10 +9,11 @@ envr scan [flags]
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for scan
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -9,10 +9,12 @@ envr sync [flags]
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for sync
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
-o, --output the format of output data (default 'table')
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
## envr uninstall
|
||||
|
||||
Remove envr configuration and database
|
||||
|
||||
### Synopsis
|
||||
|
||||
This will remove all files generated by envr from your system.
|
||||
|
||||
```
|
||||
envr uninstall [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help show this documentation
|
||||
-c, --config-file config file (default "~/.envr/config.json")
|
||||
--color Whether or not to colorize output (default 'auto')
|
||||
-f, --force Overwrite existing config
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
@@ -9,11 +9,9 @@ envr version [flags]
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for version
|
||||
-l, --long Show all version information
|
||||
-h, --help show this documentation
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [envr](envr.md) - Manage your .env files.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user