Skip to content

Commit f5f5749

Browse files
Adds log location and information for CLI. (#227)
1 parent 3a0e559 commit f5f5749

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

content/reference/command-line-interface.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -358,13 +358,15 @@ entropy sign '5DSUAf2DwxW2ebZq15Pm6Z3SJ69Ur8fGd8ytWvgxvNjYtr7c' 'Pickle Pee, Pum
358358
359359
## Configuration
360360
361-
The CLI uses a configuration file to set and store basic information. This file is saved in:
361+
The CLI uses a configuration file to set and store basic information. This CLI uses [env-paths](https://www.npmjs.com/package/env-paths) to determine where configurations files should be stored:
362362
363363
- **Arch**: `~/.config/entropy-cryptography/entropy-cli.json`
364364
- **MacOS**: `/Library/Preferences/entropy-cryptography/entropy-cli.json`
365365
- **Ubuntu**: `~/.config/entropy-cryptography/entropy-cli.json`
366366
- **Windows**: `C:\Users\<USERNAME>\AppData\Roaming\entropy-cryptography\Config\entropy-cli.json`
367367
368+
### Config file contents
369+
368370
This configuration file contains:
369371
370372
| Description | Name in configuration file |
@@ -380,7 +382,24 @@ The config file contains your unencrypted private key.
380382
381383
### Deleting your config
382384
383-
The config file gets generated the first time that you start the CLI. If you somehow _break_ your config, you can delete your existing config and start the CLI -- it will generate a new base-config.
385+
The config file gets generated the first time that you start the CLI. If you somehow _break_ your config, you can delete your existing config and start the CLI -- it will generate a new base config.
386+
387+
## Logs
388+
389+
Similar to the configuration file, log files for this CLI can be found in the default [env-paths](https://www.npmjs.com/package/env-paths) locations:
390+
391+
- **Arch**: `~/.local/state/entropy-cryptography/`
392+
- **MacOS**: `/Library/Logs/entropy-cryptography/`
393+
- **Ubuntu**: `~/.local/state/entropy-cryptography/`
394+
- **Windows**: `C:\Users\<USERNAME>\AppData\Local\entropy-cryptography\Log`
395+
396+
### Log file contents
397+
398+
There are three types of log file:
399+
400+
- **Debug**: Contains detailed technical information useful for troubleshooting during software development and maintenance.
401+
- **Error**: Records specific software failures, including the time, severity, and context of each error.
402+
- **Info**: Tracks general system events, providing a high-level overview of the application's behaviour.
384403
385404
## Troubleshooting
386405

0 commit comments

Comments
 (0)