log

Minimalist command line note manager
git clone https://codeberg.org/night0721/log
Log | Files | Refs | README | LICENSE

README.md (2370B)

      1 # log
      2 log is a minimalistic command line note manager.
      3 
      4 # Preview
      5 ![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png)
      6 
      7 # Usage
      8 ```sh
      9 Usage: ./log [-l] [-i] [-v] [-h]
     10        ./log [-I|-Q|-R|-S] [filename]
     11 log is a minimalistic command line note manager written in C.
     12 Options:
     13   -l		    Lists the notes in the directory in a tree format.
     14   -i		    Prints the directory where the notes are stored.
     15   -v		    Prints the version of the program.
     16   -h		    Show the help message.
     17   -I [filename]	Creates a new note with the name specified in the filename.
     18   -Q [filename]	Searches for the note with specified name and prints its path to the stdout.
     19   -R [filename]	Removes the note specified in the filename.
     20   -S [filename]	Prints the content of the note specified in the filename.
     21 ```
     22 
     23 # Features
     24 - Uses EDITOR environment variable to open notes
     25 - Respect XDG variables
     26 - Search notes by name with interactive prompt
     27 - Add, remove, and list notes
     28 - Customizable
     29 - Supports org, txt, markdown and html format
     30 - Generate boilerplate for notes for different formats
     31 
     32 # Dependencies
     33 None
     34 
     35 # Building
     36 You will need to run these with elevated privilages.
     37 ```
     38 $ make
     39 # make install
     40 ```
     41 
     42 # Notes
     43 log will use the editor defined in the `EDITOR` environment variable to open notes. If `EDITOR` is not defined, you will need to define it in your shell configuration file.
     44 
     45 Default file extension is `.md` and it can be changed in `config.h` file as you like. Once you change the extension, you need to recompile the program to apply the changes and the new notes will have different boilerplates. However, all commands will not work for old notes with the previous extension.
     46 
     47 When adding note, you can add a slash to indicate a subdirectory. For example, `log -I maths/ch1` will create a note called `ch1` in `maths` folder. **Note**: You can't create a note in a non-existing folder. You need to create the folder first manually.
     48 
     49 Unlike pass, you don't need to use `log init` to initialise the store, it is automatically created once you use any command. The store is either in HOME or XDG_CONFIG_HOME if it is defined.
     50 
     51 # Contributions
     52 Contributions are welcomed, feel free to open a pull request.
     53 
     54 # License
     55 This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/log/blob/master/LICENSE) for more information.