diff options
| author | triethyl <triethylammonium@pm.me> | 2025-09-02 10:48:21 -0400 |
|---|---|---|
| committer | triethyl <triethylammonium@pm.me> | 2025-09-02 10:48:21 -0400 |
| commit | 31c316d19cd974bb81a5d6de62142ff24db1c78e (patch) | |
| tree | cb941422c76cb8953830a8d58c8e14dca1a10319 /features/user/cli/scripts/spiral/plan.md | |
| parent | 1c21018347aa277caba74e554cb8d1b1e7fc6bed (diff) | |
reorganized directory structure
Diffstat (limited to 'features/user/cli/scripts/spiral/plan.md')
| -rw-r--r-- | features/user/cli/scripts/spiral/plan.md | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/features/user/cli/scripts/spiral/plan.md b/features/user/cli/scripts/spiral/plan.md deleted file mode 100644 index adbcba0..0000000 --- a/features/user/cli/scripts/spiral/plan.md +++ /dev/null @@ -1,47 +0,0 @@ -# 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` |
