Skip to content

ariedallas/Lumocards-One

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

291 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lumocards


Lumocards One is a personal information system tool.
It's a todo app, planner, calendar, and journal made for the CLI / Terminal / Powershell Etc.

It's meant to be a single point of reference for everything you track in your life, so that the bulk of your organizing and day planning can be done from one computer program in a distraction-free, minimalist format.

It's currently available for MacOS / Linux / Windows.
Lumocards is still not fully functional and is considered a prototype for an information management system.

Preview Video

https://www.youtube.com/watch?v=B6Djui-SRJE

hey


Installation Video

https://www.youtube.com/watch?v=rJgoYZR6Twk&t=29s

hey


Requirements

Getting Started

Download the Lumocards Project Folder:

Click this link to download: Download the Lumocards-One project folder

Or find the buttons in the picture below.
LUMO_download





After downloading / cloning this folder

  • Unzip the folder, if you downloaded a zip folder.
  • Open the terminal and navigate to this folder. You can get an idea of how to do this from watching part of the YouTube install video here: https://youtu.be/rJgoYZR6Twk?si=6Dc3geClP9hsSUW-&t=312
  • You can confirm you're in the right spot if your current working directory ends with something like: /Lumocards-One**
  • Then depending on your computer type, enter in the following or paste the lines below.

MacOs / Linux

    python3 -m venv venv

Then,

    source venv/bin/activate

Then,

    python3 -m pip install -e .

Windows

In Powershell:

    py -m venv venv

Then,

    .\venv\Scripts\Activate.ps1

Then,

    py -m pip install -e .

In CMD:
Do the same as Powershell except activate with the line below.

    .\venv\Scripts\activate.bat

Additional Notes

Note #1: make sure to include the period shown in the last line below (after the '-e')

Note #2: Anytime from this point onwards, when you want to use Lumo, you will first need to activate lumo. This is always done by first navigating to the Lumocards folder in the terminal and then by retyping:
source venv/bin/activate for Mac/Linux
.\venv\Scripts\activate.ps1 for Windows, or a similar command like \activate.bat

This activation process can be simplified by adding lines to a .bashrc file on Mac/Linux
or a $PROFILE file on Windows, or by making a custom script.

On most computers you should be able to tell if your environment is activated because your terminal prompt will change.

Once activated, you are ready to use Lumo.

How to: Using Keywords

To test if everything is working well, type lumo into the terminal / command line. You should see a menu come up like this:

lumo_menu

Available keywords

	
	about     ->  Show the about section.
	all       ->  Show all the Lumo sub-programs.
	browser   ->  Basic display for cards from various folders.
	agenda    ->  Show the agenda created for today.
	calendar  ->  Launch the calendar program to view events in days or weeks format.
   	              (note this will require additional setup, see the YouTube video)	    
	    
	checklist ->  Launch a program to review checklists and processes.
	journal   ->  Create or continue a journal entry for today.
	newcard   ->  Create a new card in Lumo.
	planner   ->  Launches the daily planner to review Near Focus Cards.
	pomodoro  ->  Set up a focus timer and a break timer.
	search    ->  Search for a card.
	settings  ->  Edit categories for cards.

About the Lumo Keyword

The Lumo keyword lumo is only used to launch the main menu or to directly launch subprograms keywords by
such as lumo journal. Once you are inside the main menu however, you launch subprograms with the keyword alone, i.e. journal

Keyword: About

Type about from inside the Lumo Menu.

Keyword: All

Type lumo all from the terminal -or- all from the Lumo Menu.

This keyword shows a full menu of every sub-program that is available.

Keyword: Browser

Type lumo browser from the terminal -or- browser from the Lumo Menu.

This keyword shows a menu that can display cards from various folders. e.g. 'CARDS_A_FOCUS_NEAR'.

Keyword: Calendar

Type lumo calendar from the terminal -or- calendar from the Lumo Menu.

This keyword show a basic representation of your connected Google Calendar with limited features.

Keyword: Checklist

Type lumo checklist from the terminal -or- checklist from the Lumo Menu.

This keyword launches a checklist menu which you can use to review routine checklists that you set up as 'cards'.

Keyword: Journal

Type lumo journal from the terminal -or- journal from the Lumo Menu.

This keyword launches a text editor with today's date already printed in the file and creates a .txt file with the date
included in the name. I.e. 2025_A_Jan_01_journal.txt. (The captial A is to keep all of January files together, and B for February and so on.)

Keyword: Newcard

Type lumo newcard from the terminal -or- newcard, new card from inside the Lumo Menu.

You can also make cards directly from the terminal with lumo newcard <category> <card title>.
Such as lumo newcard b my shopping list where 'b' represents the card category and 'my shopping list' is the title.
Note: you cannot type newcard <category> <card title> from the Lumo Menu, only newcard.

This keyword starts the process to create new cards which take a card category and a card title, along with optional steps for each card. Cards can be made for various locations:

  • Near Focus
  • Middle Focus
  • Distant Focus
  • Recurring
  • Checklist

Keyword: Planner

Type lumo planner or lumo cards or lumo cards planner from the terminal or planner or cards or cards planner from the Lumo Menu.

This keyword launches the process to setup a daily agenda which reviews three card categories and combines them to create a finished planner.txt file that users can reference when organizing their day. The three categories of cards are:

  • Near Focus Cards
  • Recurring Cards
  • Calendar Cards

When going through Near Focus Cards and Recurring Cards:

Users will see the > symbol displayed after every card. In this mode, there are certain keywords that are available:

  • Typing any word(s) that are not keywords will add the note you write to the finished agenda file. For example
    if you typed, "My short note" this would be added to your agenda file at the end of the Cards Planner process.

  • Pressing 'Enter' or 'Return' as an empty space will skip to the next card.

  • Typing integers such as 1 or lists of integers such as 1,2,4 will select steps from a card.

  • menu or help or options will show the menu for each card.

  • show or more or full will display more steps (if available) from the card.

  • open or edit will open the card in the text editor.

  • delete will delete the card at the end of Cards Planner.

  • archive or completed or done to move the card to Archived Cards at the end of the Cards Planner.

  • quit will skip to the next phase, Recurring Cards or Calendar Cards

  • superquit will stop the Cards Planner and finish creating the agenda up to the point you quit.

** When going through Calendar Cards typing anything has no effect. **

Keyword: Pomodoro

Type lumo pomodoro from the terminal or pomodoro from the Lumo Menu.

This keyword launches the pomodoro-style timer complete with two presets and a settings option.

Keyword: Search

Type lumo search from the terminal or search from the Lumo Menu.
From the terminal you can also type: lumo search <myterm> to directly search for a card from the terminal.

As an example lumo search hat.
Note: the term must be one word, and cannot be more than one word. Partial words are ok!
Note: you cannot type search <searchterm> from the Lumo Menu, only search.

This keyword launches the search program to look through cards.

Keyword: Settings

Type lumo settings from the terminal or settings from the Lumo Menu.
This launches the categories manager to change the card categories names and prefix letters.


Additional Info and Important Reminders

DO NOT rename any of the folders in the "__USER_FILES__" folder
or in the "__SUPPORT_FILES__" folder. Don't rename any of the folders!

If you move the main Lumocards folder, it may break and you will need to
pip install the project again using python3 -m pip install -e .

About

Lumocards One for the command line. A todo app, planner, and journaler with Google Calendar integration.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages