neurocyte/flow
neurocyte/flow
1
1
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add flags and options in help and paraphrased minilog and log usage

Browse source
This commit is contained in:
Igor Támara 2025-10-03 17:50:10 -05:00 • committed by CJ van den Berg
parent d3e601e774
commit e41ff1b7a5
1 changed files with 27 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

42
help.md
View file

@ -15,6 +15,7 @@ kitty_mod ctrl+alt
For other editors you will probably have to disable or rebind them each For other editors you will probably have to disable or rebind them each
individually. individually.
## Searching ## Searching
Press ctrl+f to search this help file. Type a search term and press Press ctrl+f to search this help file. Type a search term and press
@ -22,12 +23,15 @@ ctrl+n/ctrl+p or f3/shift+f3 to jump through the matches. Press Enter
to exit find mode at the current match or Escape to return to your to exit find mode at the current match or Escape to return to your
starting point. starting point.
## Messages and logs ## Messages and logs
Messages of issues regarding tasks that are not accomplished are Messages of issues regarding tasks that are not accomplished, like
reported to the log view, to open it, use ctrl+shift+p > View log. For trying to close flow with unsaved files, as well as other information
example, when you try to close a buffer that is not saved, or try to are shown briefly in the bottom status bar; most recent messages can
exit Flow without all the buffers saved, it will be reported in the log. be seen in the log view too, to open it, use ctrl+shift+p > `View log`;
it's possible to make it taller dragging the toolbar with the mouse
up or downwards.
## Input Modes ## Input Modes
@ -95,18 +99,19 @@ Multiple inheritance is supported with the `inherits` options like this:
... ...
``` ```
## Flow mode ### Flow mode
The default input mode, called just flow, is based on common GUI The default input mode, called just flow, is based on common GUI
programming editors. It most closely resembles Visual Studio Code, but programming editors. It most closely resembles Visual Studio Code, but
also takes some inspiration from Emacs and others. This mode focuses also takes some inspiration from Emacs and others. This mode focuses
on powerful multi cursor support with a find -> select -> modify on powerful multi cursor support with a find -> select -> modify
cycle style of editing. cycle style of editing.
See the `ctrl+f2` palette when flow mode is selected to see the full See the `ctrl+f2` palette when flow mode is selected to see the full
list of keybindings for this mode. list of keybindings for this mode.
## Vim mode
### Vim mode
The vim modes, shown as NORMAL, INSERT or VISUAL in the status bar, The vim modes, shown as NORMAL, INSERT or VISUAL in the status bar,
follow the basic modal editing style of vim. The basics follow vim follow the basic modal editing style of vim. The basics follow vim
@ -114,20 +119,21 @@ closely, but more advanced vim functions (e.g. macros and registers)
are not supported (yet). Keybindings from flow mode that do not conflict are not supported (yet). Keybindings from flow mode that do not conflict
with vim keybindings also work in vim mode. with vim keybindings also work in vim mode.
## Helix mode
The Helix modes, shown as NOR, INS or SEL in the status bar, follow ### Helix mode
the basic modal editing style of Helix. The basics are being adapted
closely, more advanced functions (e.g. surround, macros, The helix modes, shown as NOR, INS or SEL in the status bar, follow
selections, registers) are not supported (yet). Usual keybinding the basic modal editing style of helix. The basics are being adapted
with LSPs are used for tasks like 'go to definition', 'go to reference' closely, more advanced functions (e.g. surround, macros, selections,
and 'inline documentation' featuring inline diagnostics. Keybindings registers) are not supported (yet). Usual keybinding with LSPs are
used for tasks like 'go to definition', 'go to reference' and
'inline documentation' featuring inline diagnostics. Keybindings
from flow mode that do not conflict with helix keybindings also work in from flow mode that do not conflict with helix keybindings also work in
helix mode. helix mode.
(work in progress) (work in progress)
### Mouse Commands ## Mouse Commands
Mouse commands are NOT rebindable and are not listed in the command palette. Mouse commands are NOT rebindable and are not listed in the command palette.
@ -204,3 +210,9 @@ animation altogether.
File types may be configured with the `Edit file type configuration` command. You File types may be configured with the `Edit file type configuration` command. You
can also create a new file type by adding a new `.conf` file to the `file_type` can also create a new file type by adding a new `.conf` file to the `file_type`
directory. Have a look at an existing file type to see what options are available. directory. Have a look at an existing file type to see what options are available.
## Flags and options
As every respectable terminal program, flow provide various invoking
options that among others, will allow you to inspect various aspects of
the running session. Feel free to run `flow --help` to explore them.