README
¶
Overlord
Overlord is a command-line based personal assistant. It can take notes, maintain a journal, set reminders and more.
Requirements
Overlord requires Go 1.13 or later.
Usage
Overlord is used from the command line. It creates a folder in your $HOME called ~/.overlord/ and saves all application data there.
Overlord expects a command to execute.
Commands
TODO: List all commands
Installation
- Run
go get nirenjan.org/overlord - Run
overlord initand it will automatically take care of the rest.
Contributing
- Fork it ( https://github.com/nirenjan/go-overlord/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli provides the framework for adding commands to Overlord
|
Package cli provides the framework for adding commands to Overlord |
|
Package config provides configuration primitives for Overlord
|
Package config provides configuration primitives for Overlord |
|
Package log provides primitives to display log messages to stderr.
|
Package log provides primitives to display log messages to stderr. |
|
Package terminal provides helpers to manipulate the terminal This assumes that the terminal is vt100 compatible.
|
Package terminal provides helpers to manipulate the terminal This assumes that the terminal is vt100 compatible. |
|
Package version handles the CLI for the version command
|
Package version handles the CLI for the version command |
Click to show internal directories.
Click to hide internal directories.