Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 3.82 KB

README.md

File metadata and controls

128 lines (94 loc) · 3.82 KB
Raw
layout
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
true
visible
true

rlu - Rust Logseq Utility

rlu is a Rust-based command-line utility designed to interact with Logseq, a privacy-first, open-source knowledge base that works on top of local Markdown and Org-mode files. This utility provides various functionalities for managing content in Logseq.

Table of Contents

Features

  • Add Journal Entries: Add new entries to your Logseq journal.
  • Show Journal Entries: Display entries for specific dates.
  • Get Journal Entry: Retrieve a specific entry by ID.
  • Output Entry Content: Display the full content of a specific entry.
  • Add Content: Add content to existing entries.
  • Add Child Node: Add a child node to an existing entry.
  • Delete Entry: Delete a specific entry.

Installation

  1. Ensure you have Rust installed.

  2. Clone the rlu repository:

    bashgit clone https://github.com/yourusername/rlu.git

  3. Build the project using Cargo:

    bash
cd rlu 
cargo build --release // or cargo install --path .

Usage

Commands

  • Add a Journal Note:

    bashrlu add --content "Your journal content" --date "2023-10-05"

  • Show Journal Entries:

    bashrlu show --date "2023-10-05"

  • Get Journal Entry:

    bashrlu get --entry_id "entry-uuid"

  • Output Entry Content:

    bashrlu output-content --entry_id "entry-uuid"

  • Add Content to Start:

    bashrlu add-to-start --entry_id "entry-uuid" --content "New start content"

  • Append Content to End:

    bashrlu append-to-end --entry_id "entry-uuid" --content "New end content"

  • Add Child Node:

    bashrlu add-child-node --entry_id "parent-id" --content "Child node content"

  • Delete Entry:

    bashrlu delete --entry_id "entry-uuid"

Environment Variables

Set the following environment variables:

  • LOGSEQ_API_URL: URL for the Logseq API (default: http://127.0.0.1:12315/api).
  • LOGSEQ_API_KEY: Your Logseq API key for authorization.

Dependencies

  • reqwest
  • serde and serde_json
  • chrono
  • clap
  • log and env_logger

Contributing

Contributions are welcome! Fork the repository and submit a pull request for enhancements or bug fixes.

License

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

This Gitbook provides an overview of the rlu application, its features, installation instructions, usage guide, dependencies, contribution guidelines, and licensing information.

Feel free to explore the rlu application further on the GitHub repository: rlu GitHub Repository.