journal

README

Journal

Small but beautiful, simple and performance command line tool (CLI) for daily programming

How to download ?

See RELEASE

Features

• No need for Git environment, just a project folder managed by Git
• Automatically extract today's report according to the module
• Support disabling some modules
• External configuration file support

TODO

• Generate daily work reports (multiple projects), free your hands (cmd. journal stylish)
• Work communication space，realize lan command line chat and file transfer (cmd. journal exchange -c(-s) -H localhost -p 123456 )
• Generate work report statistics (line chart of submission times, pie chart of project submission rate)

Getting Start

.journal.yaml

# config version, syntax may be different for different versions in the future
version: '1'
maintainer: 4everlynn
git:
  project:
    name: Project
    # path to your git repo
    path: /home/4everlynn/dev/projcet
    # is disabled
    disable: true
  # another project here
  journal:
    name: Journal
    path: /home/4everlynn/dev/journal

Usages

stylish (reporting)

./journal stylish -d/-w/-m

Output

Config maintained by Edward is loaded successfully
20200927 Daily/Weekly/Monthly
Journal
  1、first commit
  2、Added the option of disable report generation in the warehouse
Project
  1、commit all
  2、version、depot、express and region etc.
  3、impl depot & depot-express api
  4、update query-core's version
  5、version of multipart is change, introduce query-core
  6、commit current code
  7、commit register client api
  8、client api for auth to register
  9、change genius version
  10、region changed
  11、update region api path
  12、add shipper api
  13、add global ex.h & shipper api recreate
  14、commit sys code

exchange (tcp based exchanging)

Principle

User (let's call it A for the time being) initiates the Server side, and all other users are as Clients to establish a connection with A.

The responsibility of A is to maintain and monitor the connection of the Clients and when Client has messages,
it will dispatch the message to other Clients, and at the same time.

If message generated, it is also distributed to all clients, so from a role perspective, A is like the homeowner, and all other clients are members.

server slide

./journal exchange -s -n SERVER

Output

SERVER HOST AT 127.0.0.1:9651

client

./journal exchange -c -H 127.0.0.1 -n CLIENT