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-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

97 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:

Features

  • ๐Ÿ“ Ingestion Journal, basic functionality allowing for inserting, updating, retrieving and deleting all the data stored as Ingestion model, it's structured way of storing information about substance, time, dosage and route of administration.
  • ๐Ÿ€ Substance Index, psychonautwiki-based index of substances with their dosage information, route of administration and other relevant information.

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.

Installing Shell Autocompletion

neuronek completion generate bash > ~/.local/share/bash-completion/completions/neuronek
neuronek completion generate zsh > ~/.zfunc/_neuronek
neuronek completion generate fish > ~/.config/fish/completions/neuronek.fish

Usage

โฏ neuronek --help

Ingestion Journaling

Ingestions are the cornerstone of the Neuronek tracking system, representing each instance when a user consumes a chemical compound. Each ingestion record captures critical pharmacological data: the specific substance consumed, the route of administration, precise dosage, and timestamp of consumption. The application provides a comprehensive yet intuitive command-line interface that enables users to create, retrieve, update, and delete these records with minimal friction. This structured approach to substance tracking allows for detailed analysis of consumption patterns, pharmacokinetics, and subjective effects over time, facilitating improved understanding of how various compounds affect individual physiology and psychology.

Log Ingestion

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

neuronek ingestion log -s caffeine -d 80mg
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚  ID:         1               โ”†  โ€” Onset      11:37       โ†’  11:42ยฑ5m     โ”‚
โ”‚  Substance:  Caffeine        โ”†  โ†‘ Comeup     11:42ยฑ5m    โ†’  11:52ยฑ25m    โ”‚
โ”‚  Dosage:     80.0 mg         โ”†  โ‰ก Peak       11:52ยฑ25m   โ†’  12:37ยฑ1.2h   โ”‚
โ”‚  Route:      Oral            โ”†  โ†“ Comedown   12:37ยฑ1.2h  โ†’  13:37ยฑ2.2h   โ”‚
โ”‚  Ingested:   11:37 10/04/25  โ”†  โ‰ˆ Afterglow  13:37ยฑ2.2h  โ†’  17:37ยฑ10.2h  โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

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>
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚  ID:         1               โ”†  โ€” Onset      11:37       โ†’  11:42ยฑ5m     โ”‚
โ”‚  Substance:  Caffeine        โ”†  โ†‘ Comeup     11:42ยฑ5m    โ†’  11:52ยฑ25m    โ”‚
โ”‚  Dosage:     80.0 mg         โ”†  โ‰ก Peak       11:52ยฑ25m   โ†’  12:37ยฑ1.2h   โ”‚
โ”‚  Route:      Oral            โ”†  โ†“ Comedown   12:37ยฑ1.2h  โ†’  13:37ยฑ2.2h   โ”‚
โ”‚  Ingested:   11:37 10/04/25  โ”†  โ‰ˆ Afterglow  13:37ยฑ2.2h  โ†’  17:37ยฑ10.2h  โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

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              โ”‚
โ”œโ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ 1  โ”‚ Caffeine  โ”‚ 80.0 mg โ”‚ Oral  โ”‚ 2025-04-10 11:37:30.402524844 +02:00 โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Update Ingestion

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

neuronek ingestion update 1 -d 90mg
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚  ID:         1               โ”† No phases recorded for this ingestion. โ”‚
โ”‚  Substance:  Caffeine        โ”†                                        โ”‚
โ”‚  Dosage:     90.0 mg         โ”†                                        โ”‚
โ”‚  Route:      Oral            โ”†                                        โ”‚
โ”‚  Ingested:   11:37 10/04/25  โ”†                                        โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Delete Ingestion

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

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

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 ingestion to provide insight on harm-reduction and predicting subjective effects.

Get Substance

neuronek substance get caffeine
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ Caffeine                                                                โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ Route       โ”‚ Dosage                           โ”‚ Phases                 โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ Insufflated โ”‚  (ยฑ) Threshold  โ‰ค2.50 mg         โ”‚  โ€” Onset      30s-2m   โ”‚
โ”‚             โ”‚  (+) Light      10.0 mg-25.0 mg  โ”‚  โ†‘ Comeup     30s-2m   โ”‚
โ”‚             โ”‚  (++) Common    25.0 mg-40.0 mg  โ”‚  โ‰ก Peak       30m-1h   โ”‚
โ”‚             โ”‚  (+++) Strong   40.0 mg-80.0 mg  โ”‚  โ†“ Comedown   6h-10h   โ”‚
โ”‚             โ”‚  (++++) Heavy   โ‰ฅ80.0 mg         โ”‚  โ‰ˆ Afterglow  6h-1d    โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ Oral        โ”‚  (ยฑ) Threshold  โ‰ค10.0 mg         โ”‚  โ€” Onset      5m-10m   โ”‚
โ”‚             โ”‚  (+) Light      20.0 mg-50.0 mg  โ”‚  โ†‘ Comeup     10m-30m  โ”‚
โ”‚             โ”‚  (++) Common    50.0 mg-150 mg   โ”‚  โ‰ก Peak       45m-1h   โ”‚
โ”‚             โ”‚  (+++) Strong   150 mg-500 mg    โ”‚  โ†“ Comedown   1h-2h    โ”‚
โ”‚             โ”‚  (++++) Heavy   โ‰ฅ500 mg          โ”‚  โ‰ˆ Afterglow  4h-12h   โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Contributing

The Project does not expect any external contribution. If you want to contribute, please contact me directly via keinsell@protonmail.com, 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.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7