Plain terminal
C
Get goome.h (see Getting started in C) and a goome.c with the two implementation lines.
gcc -O2 -o myapp myapp.c goome.c # linux, mac, mingw on windows
clang -O2 -o myapp myapp.c goome.c # same thing with clang
cl /O2 myapp.c goome.c # visual studio, from the developer prompt
No -ldl or anything on Linux, goome loads the desktop libs at runtime. Debug is -g -O0 and gdb ./myapp / lldb ./myapp like always.
goome.c is slow to compile, build it once:
gcc -O2 -c goome.c
gcc -O2 -o myapp main.c other.c goome.o
Working on goome itself
C#, Python and Java
cd csharp-goome && ./build.sh && dotnet run --project examples/Hello
pip install goome
python examples/hello.py # from a clone of python-goome, or your own script
Java 22+ runs one file straight from source. With more files, javac first:
java --enable-native-access=ALL-UNNAMED -cp goome-0.5.0.jar Main.java
javac -cp goome-0.5.0.jar -d out *.java
java --enable-native-access=ALL-UNNAMED -cp goome-0.5.0.jar:out Main # ; instead of : on windows
Debugging Java from the terminal is jdb, or start it with -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 and attach an IDE. See Getting started in Java for the jar.
Rust, Node, Go, Zig and Lua
Its the normal tool for each one: cargo run, node main.js, go run ., zig build run and lua main.lua. How to get goome into the project is on Rust, Node, Go, Zig and Lua.
Gotchas
GOOME_BACKEND=x11 ./myappforces a backend (wayland, gnome, portal, x11, test), otherwise it picks Wayland or X11 itself. Wayland has no global hotkeys, use the control fifo.- Over ssh or in CI theres no screen, use
GOOME_BACKEND=test(test backend). - On a Mac the terminal app is what needs Screen Recording and Accessibility, see macOS permissions.
clonly exists in the developer prompt, not a normal cmd or PowerShell.