extern/hishtory
1
0
Fork 0
mirror of https://github.com/ddworken/hishtory.git synced 2025-02-23 05:51:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document hishtory uninstall

Browse Source
This commit is contained in:
David Dworken 2022-11-02 19:53:10 -07:00
parent ba3752dae4
commit 9e3ae62510
No known key found for this signature in database
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -90,6 +90,11 @@ If you'd like to disable the control-R integration in your shell, you can do so
</details>
<details>
<summary>Uninstalling</summary>
If you'd like to uninstall hishtory, just run `hishtory uninstall`. Note that this deletes the SQLite DB storing your history, so consider running a `hishtory export` first.
</details>
## Design
The `hishtory` CLI is written in Go. It hooks into the shell in order to track information about all commands that are run. It takes this data and saves it in a local SQLite DB managed via [GORM](https://gorm.io/). This data is then encrypted and sent to your other devices through a backend that essentially functions as a one-to-many queue. When you run `hishtory query`, a SQL query is run to find matching entries in the local SQLite DB.

3
hishtory.go
View File

@ -268,8 +268,9 @@ Supported commands:
history from another machine.
'hishtory init': Set the secret key to enable syncing shell commands from another
machine with a matching secret key.
'hishtory uninstall': Permanently uninstall hishtory
'hishtory help': View this help page
`) // TODO; Update ^ to document the config-get and config-set options
`) // TODO; Update ^ to document the config-get and config-set options
default:
lib.CheckFatalError(fmt.Errorf("unknown command: %s", os.Args[1]))
}