Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gopad-dev/gopad

TUI Editor inspired by nano and powered by Tree-Sitter
https://github.com/gopad-dev/gopad

bubbletea editor golang lsp tree-sitter tui

Last synced: 4 months ago
JSON representation

TUI Editor inspired by nano and powered by Tree-Sitter

Host: GitHub
URL: https://github.com/gopad-dev/gopad
Owner: gopad-dev
License: apache-2.0
Created: 2024-04-15T22:33:31.000Z (10 months ago)
Default Branch: master
Last Pushed: 2024-09-06T23:00:32.000Z (5 months ago)
Last Synced: 2024-09-27T10:41:12.630Z (4 months ago)
Topics: bubbletea, editor, golang, lsp, tree-sitter, tui
Language: Go
Homepage: https://gopad.dev
Size: 785 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        




  

  

  



[![Go Report](https://goreportcard.com/badge/go.gopad.dev/gopad)](https://goreportcard.com/report/go.gopad.dev/gopad)

[![Go Version](https://img.shields.io/github/go-mod/go-version/gopad-dev/gopad)](https://golang.org/doc/devel/release.html)

[![gopad License](https://img.shields.io/github/license/gopad-dev/gopad)](LICENSE)

[![Build status](https://github.com/gopad-dev/gopad/actions/workflows/build.yml/badge.svg)](https://github.com/gopad-dev/gopad/actions)

[![gopad Version](https://img.shields.io/github/v/tag/gopad-dev/gopad?label=release)](https://go.gopad.dev/gopad/releases/latest)



gopad is a simple terminal-based text editor written in Go. It is inspired mostly by [nano](https://www.nano-editor.org/).

> [!IMPORTANT]

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

Table of Contents

- [Installation](#installation)

- [Usage](#usage)

    - [Flags](#flags)

    - [Environment Variables](#environment-variables)

- [Configuration](#configuration)

- [License](#license)

## Installation

```bash

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

```bash

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

gopad [command]

```

#### Commands

```bash

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

```bash

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

```

#### Flags

```bash

  -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](config) 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](LICENSE).