Skip to content

๐Ÿงฌ Terminal utility to track, analyze and predict intake of chemical compounds in name of science.

License

Notifications You must be signed in to change notification settings

keinsell/neuronek

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

53 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Neuronek

๐Ÿงฌ Intelligent dosage tracker application for monitoring supplements, nootropics and psychoactive substances along with their long-term influence on one's mind and body.

preview

About

Neuronek is an intelligent dosage tracking application designed to monitor and log the use of supplements, nootropics, and psychoactive substances. By recording and analyzing ingestion, it helps users better understand the long-term effects of these compounds on their physical and mental health.

Features offered by application include:

  • Ingestion journaling with a set of commands which allows for inserting, updating, retrieving and deleting all the data stored as Ingestion model.

Installation

To install the application, please visit the GitHub Releases Page for pre-built binaries and installation instructions for your platform. Alternatively, you can install the application from supported package managers or build it from source.

Using a package manager (recommended)

Warning

Application is in early stage of development and to avoid polluting package managers with application that can be potentially dead in few months I do recommend installing from source or using available pre-build binaries. Application will be available for homebrew, pacman, nix, scoop, dnf and apt when it would be considered production-ready.

Installation from source (Advanced)

Application can be installed with cargo and providing url to this repository, this may be the most conformable way for users which are looking for the latest version of application, proceed only if you have development experience as application might require manual fixes from your side by this release channel.

cargo install --git https://github.com/keinsell/neuronek

Note: This method might be best for users who always want the absolute newest version of the application. However, it may be less stable than the pre-built binaries.

โฏ neuronek --help

Usage

Ingestion Journaling

Ingestions are a fundamental area of application, they represent human interaction with the chemical compound of choice. Ingestion explains what compound was ingested, how it was ingested and when it was ingested. Applications expose a simple, scriptable interface which allows for storage and retrieval of structured data.

Log Ingestion

Logs the ingestion of a specified substance with the given dosage.

neuronek ingestion log -s caffeine -d 80mg
---
Ingestion #88 

ID: 88
Substance: caffeine
Dosage: 80.0 mg
Route: Oral
Ingested At: 2025-03-06 11:23:06

Timeline

Analysis of ingestion progression based on substance information in database.
Note: Estimates may not be accurate.

โ”‚   Phase   โ”‚ Start Time โ”‚  End Time  โ”‚  Duration  โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚โ–ฒ Onset    โ”‚11:23  ยฑ0m  โ”‚11:28  ยฑ5m  โ”‚7m  ยฑ2m     โ”‚
โ”‚โ–ณ Comeup   โ”‚11:28  ยฑ5m  โ”‚11:38  ยฑ25m โ”‚20m  ยฑ10m   โ”‚
โ”‚โ—† Peak     โ”‚11:38  ยฑ25m โ”‚12:23  ยฑ70m โ”‚1h 7m  ยฑ22m โ”‚
โ”‚โ–ฝ Comedown โ”‚12:23  ยฑ70m โ”‚13:23  ยฑ130mโ”‚1h 30m  ยฑ30mโ”‚
โ”‚โ—‹ Afterglowโ”‚13:23  ยฑ130mโ”‚17:23  ยฑ610mโ”‚8h 0m  ยฑ240mโ”‚

Timeline Visualization

Total Duration: ~2.0 hours
Start: 11:23 | Current: 11:23 | End: 13:23
[>                                                 ] 0%
[โ–ฒ โ–ณ   โ—†                  โ–ฝ                        ]

Legend: โ–ฒ = Onset, โ–ณ = Comeup, โ—† = Peak, โ–ฝ = Comedown, โ—‹ = Afterglow

View Ingestion

Displays detailed information about a specific ingestion identified by its ID.

![WARNING] Ingestion viewing user interface is a subject to change to one that would be compact yet will contain most important information, please share your feedback and expectations in revelant github issues.

neuronek ingestion view <INGESTION_ID>
---
Ingestion #88 

ID: 88
Substance: caffeine
Dosage: 80.0 mg
Route: Oral
Ingested At: 2025-03-06 11:23:06

Timeline

Analysis of ingestion progression based on substance information in database.
Note: Estimates may not be accurate.

โ”‚   Phase   โ”‚ Start Time โ”‚  End Time  โ”‚  Duration  โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚โ–ฒ Onset    โ”‚11:23  ยฑ0m  โ”‚11:28  ยฑ5m  โ”‚7m  ยฑ2m     โ”‚
โ”‚โ–ณ Comeup   โ”‚11:28  ยฑ5m  โ”‚11:38  ยฑ25m โ”‚20m  ยฑ10m   โ”‚
โ”‚โ—† Peak     โ”‚11:38  ยฑ25m โ”‚12:23  ยฑ70m โ”‚1h 7m  ยฑ22m โ”‚
โ”‚โ–ฝ Comedown โ”‚12:23  ยฑ70m โ”‚13:23  ยฑ130mโ”‚1h 30m  ยฑ30mโ”‚
โ”‚โ—‹ Afterglowโ”‚13:23  ยฑ130mโ”‚17:23  ยฑ610mโ”‚8h 0m  ยฑ240mโ”‚

Timeline Visualization

Total Duration: ~2.0 hours
Start: 11:23 | Current: 11:23 | End: 13:23
[>                                                 ] 0%
[โ–ฒ โ–ณ   โ—†                  โ–ฝ                        ]

Legend: โ–ฒ = Onset, โ–ณ = Comeup, โ—† = Peak, โ–ฝ = Comedown, โ—‹ = Afterglow

List Ingestions

Lists all recorded ingestions along with their details such as ID, substance, route of administration, dosage, and ingestion date.

neuronek ingestion list
---
โ•ญโ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ ID โ”‚ Substance โ”‚ Dosage  โ”‚ Route โ”‚ Ingested At                          โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 33 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:40:04.705901008 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 32 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:30:43.702279077 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 31 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:29:44.948833745 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 30 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:29:38.685091465 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 29 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:24:43.550999449 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 28 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:17:41.020152562 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 27 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:15:57.546015179 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 26 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:10:23.044092301 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 25 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:09:47.632702987 +01:00 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 24 โ”‚ caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-03-06 06:08:58.809500208 +01:00 โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Update Ingestion

Updates the dosage of a specific ingestion identified by its ID.

neuronek ingestion update 14 -d 90mg
---
Ingestion #88 

ID: 88
Substance: caffeine
Dosage: 80.0 mg
Route: Oral
Ingested At: 2025-03-06 11:23:06

Timeline

Analysis of ingestion progression based on substance information in database.
Note: Estimates may not be accurate.

โ”‚   Phase   โ”‚ Start Time โ”‚  End Time  โ”‚  Duration  โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚โ–ฒ Onset    โ”‚11:23  ยฑ0m  โ”‚11:28  ยฑ5m  โ”‚7m  ยฑ2m     โ”‚
โ”‚โ–ณ Comeup   โ”‚11:28  ยฑ5m  โ”‚11:38  ยฑ25m โ”‚20m  ยฑ10m   โ”‚
โ”‚โ—† Peak     โ”‚11:38  ยฑ25m โ”‚12:23  ยฑ70m โ”‚1h 7m  ยฑ22m โ”‚
โ”‚โ–ฝ Comedown โ”‚12:23  ยฑ70m โ”‚13:23  ยฑ130mโ”‚1h 30m  ยฑ30mโ”‚
โ”‚โ—‹ Afterglowโ”‚13:23  ยฑ130mโ”‚17:23  ยฑ610mโ”‚8h 0m  ยฑ240mโ”‚

Timeline Visualization

Total Duration: ~2.0 hours
Start: 11:23 | Current: 11:23 | End: 13:23
[>                                                 ] 0%
[โ–ฒ โ–ณ   โ—†                  โ–ฝ                        ]

Legend: โ–ฒ = Onset, โ–ณ = Comeup, โ—† = Peak, โ–ฝ = Comedown, โ—‹ = Afterglow

Delete Ingestion

Deletes a specific ingestion identified by its ID from the records.

neuronek ingestion delete 14
Output
Ingestion #14 has been successfully deleted.

Monitor Command

Launch an interactive Terminal User Interface (TUI) to visualize and monitor substance effects in real-time.

neuronek monitor

Substances

Application comes with a pre-bundled database of psychoactive substances built on top of PsychonautWiki, such information is easily queryable through CLI and is foundation for further analysis of user's ingestions to provide insight on harm-reduction and predicting subjective effects.

Get Substance [Under Development]

Application can preview information about compounds from initially provided dataset, however, due to the highly nested nature of information the clean and human-friendly interface is needed to be designed and developed and implementation of such to this application by its nature is questionable.

neuronek substance get caffeine
---
{
  "name": "Caffeine",
  "common_names": "",
  "routes_of_administration": [
    {
      "name": "Insufflated",
      "dosages": [
        {
          "classification": "Heavy",
          "dosage_min": "80.0 mg",
          "dosage_max": "N/A"
        },
        {
          "classification": "Strong",
          "dosage_min": "40.0 mg",
          "dosage_max": "80.0 mg"
        },
        {
          "classification": "Light",
          "dosage_min": "10.0 mg",
          "dosage_max": "25.0 mg"
        },
        {
          "classification": "Threshold",
          "dosage_min": "N/A",
          "dosage_max": "2.50 mg"
        },
        {
          "classification": "Medium",
          "dosage_min": "25.0 mg",
          "dosage_max": "40.0 mg"
        }
      ],
      "phases": [
        {
          "name": "Onset",
          "duration_min": "PT30S",
          "duration_max": "PT2M"
        },
        {
          "name": "Afterglow",
          "duration_min": "PT6H",
          "duration_max": "P1D"
        },
        {
          "name": "Comeup",
          "duration_min": "PT30S",
          "duration_max": "PT2M"
        },
        {
          "name": "Comedown",
          "duration_min": "PT6H",
          "duration_max": "PT10H"
        },
        {
          "name": "Peak",
          "duration_min": "PT30M",
          "duration_max": "PT1H"
        }
      ]
    },
    {
      "name": "Oral",
      "dosages": [
        {
          "classification": "Medium",
          "dosage_min": "50.0 mg",
          "dosage_max": "150 mg"
        },
        {
          "classification": "Heavy",
          "dosage_min": "500 mg",
          "dosage_max": "N/A"
        },
        {
          "classification": "Threshold",
          "dosage_min": "N/A",
          "dosage_max": "10.0 mg"
        },
        {
          "classification": "Strong",
          "dosage_min": "150 mg",
          "dosage_max": "500 mg"
        },
        {
          "classification": "Light",
          "dosage_min": "20.0 mg",
          "dosage_max": "50.0 mg"
        }
      ],
      "phases": [
        {
          "name": "Comeup",
          "duration_min": "PT10M",
          "duration_max": "PT30M"
        },
        {
          "name": "Comedown",
          "duration_min": "PT1H",
          "duration_max": "PT2H"
        },
        {
          "name": "Afterglow",
          "duration_min": "PT4H",
          "duration_max": "PT12H"
        },
        {
          "name": "Peak",
          "duration_min": "PT45M",
          "duration_max": "PT1H30M"
        },
        {
          "name": "Onset",
          "duration_min": "PT5M",
          "duration_max": "PT10M"
        }
      ]
    }
  ]
}

Statistics

View Statistics

Contributing

The Project does not expect any external contribution. If you want to contribute, please contact me directly via [email protected], and we can discuss the project together and move code to organization out of my profile.

See CONTRIBUTING.md for more information.

License

Read the LICENSE file for more information.