Reference
Reference
The exact commands, signatures and tables, without a narrative.
Reference pages are for looking something up, not for reading end to end. They
describe the surface you use: the cppgo command, which turns a C++ header into
a Go package that calls the compiled library; the generated Go package itself;
and the cppgo package that package imports. They say so when a row is designed
rather than shipped.
| You want | Look up |
|---|---|
| the subcommands, their flags and exit codes, and the files a run writes | Command line |
| the Go type or function a C++ declaration becomes, and the C++ it came from | Generated API |
| the Go package a generated binding imports: loading, objects, callbacks and errors | Runtime |
How a call reaches C++, and what each choice costs, is in Carriers and the construct table. For a task rather than a lookup, the how-to guides start at Generate a binding for your own library; to learn the whole flow from the beginning, start at Bind your first C++ class.
- Command line
cppgo gen, build, check, version and help: every flag and exit code.
- Generated API
The Go shapes cppgo gen writes for records, classes, functions and templates, and the C++ declarations they come from.
- Runtime
The cppgo package: loading, calls, objects, wire helpers and errors.