OS Manuals

/usr/bin/guacgql

From guacgql 1.1.0-r42 (os), captured 2026-11-08 by running guacgql --help (exit 0). permalink

{"level":"info","ts":1794106093.9896939,"caller":"logging/logger.go:79","msg":"Logging at info level","guac-version":"1.1.0"}
GUAC GraphQL server

Usage:
  guacgql [flags]

Flags:
      --arango-addr string         address to arango db (default "http://localhost:8529")
      --arango-pass string         arango password to connect to graph db
      --arango-user string         arango user to connect to graph db
      --db-address string          Full URL of database to connect to (default "postgres://guac:guac@0.0.0.0:5432/guac?sslmode=disable")
      --db-conn-time string        sets the maximum amount of time a connection may be reused in m, h, s, etc.
      --db-debug                   enable debug logging for database queries
      --db-driver string           database driver to use, one of [postgres | sqlite3 | mysql] or anything supported by sql.DB (default "postgres")
      --db-migrate                 automatically run database migrations on start (default true)
      --enable-otel                enable otel metrics and tracing
      --enable-prometheus          enable prometheus metrics
      --gql-backend string         backend used for graphql api server: [keyvalue | arango (experimental) | ent (experimental) | neo4j (unmaintained)] (default "keyvalue")
      --gql-debug                  debug flag which enables the graphQL playground
      --gql-listen-port int        port used for graphql api server (default 8080)
      --gql-tls-cert-file string   path to the TLS certificate in PEM format for graphql api server
      --gql-tls-key-file string    path to the TLS key in PEM format for graphql api server
      --gql-trace                  flag which enables tracing of graphQL requests and responses on the console
  -h, --help                       help for guacgql
      --kv-redis string            Experimental: Redis connection string for keyvalue backend (default "redis://user@localhost:6379/0")
      --kv-store string            Which keyvalue store to use: memmap, redis, tikv. (default "memmap")
      --kv-tikv string             Experimental: TiKV address and port (default "127.0.0.1:2379")
      --neo4j-addr string          address to neo4j db (default "neo4j://localhost:7687")
      --neo4j-pass string          neo4j password credential to connect to graph db
      --neo4j-realm string         realm to connect to graph db (default "neo4j")
      --neo4j-user string          neo4j user credential to connect to graph db
      --neptune-endpoint string    address to neptune db (default "localhost")
      --neptune-port int           port used for neptune db connection (default 8182)
      --neptune-realm string       realm to connect to graph db (default "neptune")
      --neptune-region string      region to connect to neptune db (default "us-east-1")
      --neptune-user string        neptune user credential to connect to graph db
  -v, --version                    version for guacgql
Options (30)
OptionDescriptionSource
--arango-addr stringaddress to arango db (default "http://localhost:8529")help
--arango-pass stringarango password to connect to graph dbhelp
--arango-user stringarango user to connect to graph dbhelp
--db-address stringFull URL of database to connect to (default "postgres://guac:guac@0.0.0.0:5432/guac?sslmode=disable")help
--db-conn-time stringsets the maximum amount of time a connection may be reused in m, h, s, etc.help
--db-debugenable debug logging for database querieshelp
--db-driver stringdatabase driver to use, one of [postgres | sqlite3 | mysql] or anything supported by sql.DB (default "postgres")help
--db-migrateautomatically run database migrations on start (default true)help
--enable-otelenable otel metrics and tracinghelp
--enable-prometheusenable prometheus metricshelp
--gql-backend stringbackend used for graphql api server: [keyvalue | arango (experimental) | ent (experimental) | neo4j (unmaintained)] (default "keyvalue")help
--gql-debugdebug flag which enables the graphQL playgroundhelp
--gql-listen-port intport used for graphql api server (default 8080)help
--gql-tls-cert-file stringpath to the TLS certificate in PEM format for graphql api serverhelp
--gql-tls-key-file stringpath to the TLS key in PEM format for graphql api serverhelp
--gql-traceflag which enables tracing of graphQL requests and responses on the consolehelp
-h, --helphelp for guacgqlhelp
--kv-redis stringExperimental: Redis connection string for keyvalue backend (default "redis://user@localhost:6379/0")help
--kv-store stringWhich keyvalue store to use: memmap, redis, tikv.help
--kv-tikv stringExperimental: TiKV address and port (default "127.0.0.1:2379")help
--neo4j-addr stringaddress to neo4j db (default "neo4j://localhost:7687")help
--neo4j-pass stringneo4j password credential to connect to graph dbhelp
--neo4j-realm stringrealm to connect to graph db (default "neo4j")help
--neo4j-user stringneo4j user credential to connect to graph dbhelp
--neptune-endpoint stringaddress to neptune db (default "localhost")help
--neptune-port intport used for neptune db connection (default 8182)help
--neptune-realm stringrealm to connect to graph db (default "neptune")help
--neptune-region stringregion to connect to neptune db (default "us-east-1")help
--neptune-user stringneptune user credential to connect to graph dbhelp
-v, --versionversion for guacgqlhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.