From 31c316d19cd974bb81a5d6de62142ff24db1c78e Mon Sep 17 00:00:00 2001
From: triethyl <triethylammonium@pm.me>
Date: Tue, 2 Sep 2025 10:48:21 -0400
Subject: reorganized directory structure

---
 home-manager/features/cli/scripts/spiral/plan.md | 47 ++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 home-manager/features/cli/scripts/spiral/plan.md

(limited to 'home-manager/features/cli/scripts/spiral/plan.md')

diff --git a/home-manager/features/cli/scripts/spiral/plan.md b/home-manager/features/cli/scripts/spiral/plan.md
new file mode 100644
index 0000000..adbcba0
--- /dev/null
+++ b/home-manager/features/cli/scripts/spiral/plan.md
@@ -0,0 +1,47 @@
+# Spiral Plan
+
+## Main Functions
+
+Are ran by the user.
+
+- `main new (--no-frontmatter (-n)) (title: <string>)`
+- `main open (--by-title (-t)) (--by-contents (-c)) (title: <string>)`
+- `main tags (tag: <string>)`
+- `main remove (--by-title (-t)) (--by-contents (-c)) (title: <string>)` 
+- `main list`
+- `main restore (--by-title (-t)) (--by-contents (-c)) (title: <string>)`
+- `main journal (date: <string>)`
+
+## Action Functions
+
+Accept parameters and perform an action.
+
+- `create_note (--no-frontmatter) --title <string>`
+- `create_journal_entry --title <string>`
+- `open_file_in_editor --dir <dir>`
+
+## Interface Functions
+
+Accept a prompt and other data and return a value from the user.
+
+- `get_confirmation --prompt <string> -> bool`
+- `get_string_input --prompt <string> -> string`
+- `get_choice_from_list --list <list> -> string`
+- `get_choice_from_dir --dir <dir> -> path`
+- `get_choice_from_dir_file_contents --dir <dir> -> path: line number`
+- `get_choice_from_note_titles --dir <dir> -> path`
+
+## String Manipulation Functions
+
+Accept, modify, and return strings.
+
+- `title_to_path title: <string> -> path`
+- `strip_line_number string: <string> -> string`
+- `generate_note_text (--no-frontmatter) --title <string> -> string`
+
+## File Manipulation Functions
+
+Read, write, or otherwise manipulate files.
+
+- `parse_note_frontmatter path: <path> -> record`
+- `list_notes -> table`
-- 
cgit v1.2.3