Skip to content

hzhang08/gocat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gocat: Terminal Go Game SGF Viewer & Editor

gocat is a modern, interactive terminal tool for viewing and editing Go game records in SGF (Smart Game Format). It offers a powerful, keyboard-driven interface to navigate, annotate, and modify game records directly from your terminal, making it ideal for Go players and reviewers.

Screenshot of gocat in action


Installation

Install gocat via Homebrew:

brew tap hzhang08/gocat
brew install gocat

Install gocat via Cargo:

cargo install gocat

Publishing Instructions

  1. Update version in Cargo.toml and commit
  2. Run cargo publish --dry-run
  3. Run cargo publish
  4. Check out main branch on Mac
  5. Make sure rust has architecture x86_64-apple-darwin and aarch64-apple-darwin installed, by running rustup target list
  6. Run cargo build --target x86_64-apple-darwin --release and cargo build --target aarch64-apple-darwin --release
  7. go to target/x86_64-apple-darwin/release and target/aarch64-apple-darwin/release directories and run tar -czvf gocat-x86_64-apple-darwin.tar.gz gocat and tar -czvf gocat-aarch64-apple-darwin.tar.gz gocat
  8. To get sha256 of the tar files, run shasum -a 256 gocat-x86_64-apple-darwin.tar.gz and shasum -a 256 gocat-aarch64-apple-darwin.tar.gz
  9. Go to Github gocat repository and create a new release with the tar files
  10. Go to homebrew-gocat repository, update Formula/gocat.rb with the new version and sha256 sums
  11. Done

Usage

To launch the interactive SGF viewer/editor:

gocat <your_file.sgf>

Replace <your_file.sgf> with the path to your SGF file.


Features & Hotkeys

  • q Quit
  • n / Next move
  • p / Previous move
  • ] Next commented move
  • [ Previous commented move
  • g Goto move number
  • m Modify current move
  • / Search for coordinate
  • c Add/Edit move comment
  • t Add/Edit triangles
  • i Insert new move
  • x Remove current move
  • h Show this help
  • Esc/Enter Close help or input dialogs

About

A terminal Go game SGF (Smart Game Format) viewer and editor

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages