Information for CLI contributors

Contributors should research and understand first

• https://en.wikipedia.org/wiki/Termcap
• https://en.wikipedia.org/wiki/Curses_(programming_library)
• TERM environment variable
• libreadline - https://cnswww.cns.cwru.edu/php/chet/readline/rltop.html
• TTY / PTY - https://en.wikipedia.org/wiki/Pseudoterminal
• TTY Signals - http://www.linusakesson.net/programming/tty/
• VT220 Programmer Reference Manual - https://vt100.net/docs/vt220-rm/
  • https://vt100.net/docs/vt220-rm/chapter4.html - 4.7 Cursor Positioning

Tips and Guidelines

• CLI entry point is at lib/cli.ngs . It's called from lib/bootstrap.ngs .

  • Current CLI readline implementation is not meant to stay, readline will probably not be a good fit for NGS
  • Current CLI readline implementation is based on unfinished FFI implementation, which is not stable (API can change)

• All UI (such as Web UI) functionality that is implemented should be able to gracefully degrade and work in TTY.