gopad is a simple terminal-based text editor written in Go. It is inspired mostly by nano.

Important

gopad is still very much wip and not ready for general use.

Table of Contents

• Installation
• Usage
  • Flags
  • Environment Variables
• Configuration
• License

Installation

git clone https://github.com/gopad-dev/gopad.git
  
cd gopad

./install.sh

(go install go.gopad.dev/gopad@latest is currently not working due to replace directives in the go.mod file.)

Usage

gopad [flags]... [dir | file]...
gopad [command]

Commands

completion  Generate the autocompletion script for the specified shell
  bash        Generate the autocompletion script for bash
  fish        Generate the autocompletion script for fish
  powershell  Generate the autocompletion script for powershell
  zsh         Generate the autocompletion script for zsh
config      Create a new config directory with default config files
grammar     Manage Tree-Sitter grammars
  install     Install Tree-Sitter grammars
  list        List configured Tree-Sitter grammars
  remove      Remove installed Tree-Sitter grammars
  update      Check for updates of Tree-Sitter grammars
help        Help about any command
version     Show version information

Global Flags

  -c, --config-dir string   set configuration directory (Default: ./.gopad, $XDG_CONFIG_HOME/gopad or $HOME/.config/gopad)

Flags

  -d, --debug string        set debug log file
  -l, --debug-lsp string    set debug lsp log file
  -h, --help                help for gopad
  -p, --pprof string        set pprof address:port
  -w, --workspace string    set workspace directory (Default: first directory argument)

Configuration

gopad uses multiple TOML configuration files. See the default configuration directory for all configuration files. To create a new configuration directory with default configuration files, run gopad config.

Environment Variables

• GOPAD_CONFIG_HOME - Use the specified directory for configuration files. (Default: ./.gopad, $XDG_CONFIG_HOME/gopad or $HOME/.config/gopad)

License

gopad is licensed under the Apache License 2.0.