README
¶
Daily Command
This project is under constructing
This command is for daily report.
Installation
- Install fzf command.
- Run command:
go get github.com/tomato3713/daily. - Run Command:
daily config create. - Set your favorite text editor to
Editorin the configuration file. - start writing your daily report. Run Command:
daily report. If occured any error, please open issues.
Usage
report
This subcommand is for writing daily report at today. So, make today daily report file if it is not exists, initialized by template file. This file name is "yyyy-mm-dd-daily-report.md".
daily report
serve
Serve daily report directory.
daily serve
| Env Var | Value | Implement |
|---|---|---|
| Name | Report file name | O |
| Date | Report Written Date | X |
| Abstruct | Abstruct | X |
config
no test code
There are sub command for configuration.
# make new cofiguration file in $HOME/.config/daily/daily.toml if not exists.
daily config create
# show config file
daily config
and this configuration file format is under.
# File: $HOME/.config/daily/daily.toml
reportDir = "path to daily report file directory"
templateFile = "path to template file"
pluginDir = "path to plugin directory"
Editor = "code"
[Serve]
templateIndexFile = "path to index.tmpl"
templateBodyFile = "path to body.tmpl"
assetsDir = "path to assets directory"
list
Partly implemented
Show daily report file path list and part of contents.
daily list
cat
Prints daily report you want.
This command find in reportDir in configuration file.
daily cat # required fzf command for file selection
# print daily report content of yyyy/mm/dd.
daily cat yyyy mm dd
Global Option
---configSet the path to configuration file. Example:
daily config --config .
Thanks
Documentation
¶
Overview ¶
Copyright © 2020 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories