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

go install go.gopad.dev/gopad@latest

Usage

gopad (--help) (--debug=debug.log) (--pprof=localhost:6060) (--config-dir=config) (--create-config=config) [file | directory]

Flags

All flags are optional.

• --help - Show the help message.
• --debug=debug.log - Enable debug logging to the specified file.
• --pprof=localhost:6060 - Enable pprof on the specified address.
• --config-dir=config - Use the specified configuration file. (Default: ./.gopad, $XDG_CONFIG_HOME/gopad or $HOME/.config/gopad)
• --create-config=config - Create a default configuration file at the specified location.

Environment Variables

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

Configuration

gopad uses multiple TOML configuration files. See the default configuration directory for all configuration files.

License

gopad is licensed under the Apache License 2.0.