Logfolio CLI

A command-line interface (CLI) tool to push logs to Logfolio. Easily track and manage your work logs directly from the terminal with simple commands and authentication options.

Table of Contents

• Logfolio CLI
  • Table of Contents
  • Installation
  • Usage
    • Authentication Methods
    • Commands
      • login
      • push <content>
  • Examples
    • Login
    • Push a Log Entry
  • License

Installation

Install the Logfolio CLI tool globally using pnpm:

pnpm install -g logfolio

Note: This will make the worklog command available globally on your system.

Usage

After installation, you can use the worklog command in your terminal.

Authentication Methods

Before pushing logs, you need to authenticate using one of the following methods:

• Email: Authenticate using your email and password registered with Logfolio.
• GitHub: Authenticate via your GitHub account.

Commands

login

Login to your Logfolio account using either email or GitHub.

Options:

• --auth <method>: Choose the authentication method (email, github or google). If not specified, you will be prompted to select an authentication method.

Usage:

worklog login

or

worklog login --auth <method>

push <content>

Push a log entry to Logfolio.

Usage:

worklog push "Your log content here"

This command will use the current session to send the log entry to Logfolio. If you haven't logged in yet, you'll be prompted to authenticate.

Examples

Login

worklog login 

• Output:

  ★ Login to Logfolio
  ? Please choose your authentication method: (Use arrow keys)
  ❯ email
    github
    google

Push a Log Entry

Once authenticated, you can push logs using the following command:

worklog push "Completed feature implementation"

• Output:

  Log pushed successfully!

License

This project is licensed under the MIT License. See the LICENSE file for details.