go/

directory
v2.204.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 10, 2020 License: Apache-2.0, MIT

README

Berty go/

go.dev reference Code coverage

Please, read the main README.md file first.

This folder contains most of the go code needed by the project.

Download

Main binary:

git clone https://github.com/berty/berty
cd berty/go
make install

# if things go wrong, please run and share the result of
make doctor

Main components

  • ./cmd/...: binaries / entrypoints
    • cd go; make install
  • ./pkg/...: packages especially made to be imported by other projects
  • ./internal/: internal packages that can be useful to understand how things are working under the hood
    • you won't be able to import them directly from your projects; if you think that an internal package should be made public, open an issue
  • ./framework: bridges used by mobile apps

Usage

Daemon
foo@bar:~$ berty daemon
Unable to find image 'bertytech/berty:latest' locally
latest: Pulling from bertytech/berty


188c0c94c7c5: Pulling fs layer 


43348fd2b7b8: Pulling fs layer 


d80477436c57: Pulling fs layer 

188c0c94c7c5: Downloading [>                                                  ]  29.17kB/2.797MB

d80477436c57: Downloading [>                                                  ]  531.7kB/130MB

188c0c94c7c5: Download complete 

188c0c94c7c5: Extracting [>                                                  ]  32.77kB/2.797MB

188c0c94c7c5: Extracting [==================================================>]  2.797MB/2.797MB

d80477436c57: Downloading [===>                                               ]   8.01MB/130MB

188c0c94c7c5: Pull complete 

d80477436c57: Downloading [=======>                                           ]  19.79MB/130MB

d80477436c57: Downloading [=========>                                         ]  24.06MB/130MB

d80477436c57: Downloading [============>                                      ]  33.18MB/130MB

d80477436c57: Downloading [==============>                                    ]  37.49MB/130MB

d80477436c57: Downloading [=================>                                 ]  44.97MB/130MB

43348fd2b7b8: Downloading [>                                                  ]  4.107kB/321.7kB

d80477436c57: Downloading [====================>                              ]  54.05MB/130MB

43348fd2b7b8: Download complete 

43348fd2b7b8: Extracting [=====>                                             ]  32.77kB/321.7kB

43348fd2b7b8: Extracting [==================================================>]  321.7kB/321.7kB

43348fd2b7b8: Extracting [==================================================>]  321.7kB/321.7kB

d80477436c57: Downloading [======================>                            ]  57.82MB/130MB

43348fd2b7b8: Pull complete 

d80477436c57: Downloading [==========================>                        ]  68.52MB/130MB

d80477436c57: Downloading [=============================>                     ]  77.57MB/130MB

d80477436c57: Downloading [=================================>                 ]  86.71MB/130MB

d80477436c57: Downloading [=====================================>             ]  97.95MB/130MB

d80477436c57: Downloading [=========================================>         ]  108.1MB/130MB

d80477436c57: Downloading [=============================================>     ]  117.7MB/130MB

d80477436c57: Verifying Checksum 

d80477436c57: Download complete 

d80477436c57: Extracting [>                                                  ]  557.1kB/130MB

d80477436c57: Extracting [==>                                                ]  7.242MB/130MB

d80477436c57: Extracting [=====>                                             ]  13.93MB/130MB

d80477436c57: Extracting [========>                                          ]  22.28MB/130MB

d80477436c57: Extracting [=============>                                     ]  33.98MB/130MB

d80477436c57: Extracting [================>                                  ]  44.01MB/130MB

d80477436c57: Extracting [===================>                               ]  51.81MB/130MB

d80477436c57: Extracting [======================>                            ]  58.49MB/130MB

d80477436c57: Extracting [============================>                      ]  73.53MB/130MB

d80477436c57: Extracting [==============================>                    ]  80.22MB/130MB

d80477436c57: Extracting [=================================>                 ]  88.01MB/130MB

d80477436c57: Extracting [======================================>            ]  100.8MB/130MB

d80477436c57: Extracting [=========================================>         ]  108.6MB/130MB

d80477436c57: Extracting [============================================>      ]    117MB/130MB

d80477436c57: Extracting [==================================================>]    130MB/130MB

d80477436c57: Pull complete 
Digest: sha256:779d82a6dbb025f0181e18eeb8403f28c1876feffe39535c253b2d74d5484597
Status: Downloaded newer image for bertytech/berty:latest
...

Now you can interact with the daemon API.

Mini

TODO

Share Invite
foo@bar:~$ berty share-invite
█████████████████████████████████████████████████
█████████████████████████████████████████████████
████ ▄▄▄▄▄ ██▀▄▀ ▄  ▀  ▀▀█▀  ▄▀▀█▄▄▀▀█ ▄▄▄▄▄ ████
████ █   █ █▄▀ ▄█  ▀ █▀▄██ █ ██▀██▄█ █ █   █ ████
████ █▄▄▄█ ██ ▀ █▄ ▀ █▄ ▀▀▄ █▀█▀█▀▀ ██ █▄▄▄█ ████
████▄▄▄▄▄▄▄█ █ █ ▀ ▀▄▀ ▀ ▀ █▄▀▄█▄▀▄█ █▄▄▄▄▄▄▄████
████   ▀▄ ▄ ▄▄▄▄█ ▀█ ▄█▀ ▀██ ▄ ▄▀▀▀█   ▀█▀▄██████
████ █▀█▄█▄▀ ▄   ▀ █▀ ▀▀   ▀█▀▄▀█▀ ███▄█▄██ ▄████
████▀▄ █ ▀▄ ██   ▀ ▀ ▀▄▄  ▄█▀▀▀    ▀ ▄▄▄▄ ██▀████
██████▀█▄█▄▀▀▄▄▄   ▄ ▀ ▀  ███ ▀▀█▀▄▀█▄▀▀ ██▄▄████
████▀▄██▀█▄█▀█ ▄█▄ ▄█▄ ▀  █▄ ██ ▀ █▀ ▀ ██▄▄▄ ████
██████▄▄▄▀▄▄▀█▀█▄▄██▄▄██▄ █▀█▀▄▀▄  ▀▀▄▄  █▄█ ████
████▀ ▄ ▄▄▄█▀▄█▀█▀█ █▀██ ▄█  ▄ ▄ ▀▀ ▀█ ▄█ █  ████
████▄ ▀█▄█▄▀▀▀▄▀█ ▀▀█▀▀▀▀ ▀▀▀▀▄▀▀ ▀▀ █   ▄▄  ████
████▄▀ █▀█▄▄█▀ █▀▀█▀▀  ▄█▄██  ▀▀ ▄█▄█  ██ ▀█▄████
█████  ██ ▄▀▀▄██▄▀ ▀▄▀ ▀  ███▀▄▀▀ ▄▀█▄▄▄▀ ▄▄ ████
█████▄▄ ▀▄▄ █  ▀ ▀   █ ██▄█▄█▀██▀██  ▄ █▄▄█▀ ████
████▄▀▀ █▀▄▄█▄█▄  ▄▄ ▀▄▀▀▀██▀ ▄▀█▀▄█ █▀██ ▄▄▄████
████▄█▄██▄▄█ ▀ ▄███▄ ▄██▀  █ ▄ ▄ ▄ █ ▄▄▄  ▀▄ ████
████ ▄▄▄▄▄ █ ▄ █▀▄██▀▄███▀ █▀  █▄ ▀▄ █▄█ ▀█▄▄████
████ █   █ █▄ ▀▀███▀████  ██  ▀▀▀ ██▄▄▄  ███▀████
████ █▄▄▄█ █  █▀█▀ ▀█  ▀▀ ▄▀▀▀▄▀▀▀ ▄ ▀██ █▄ ▄████
████▄▄▄▄▄▄▄█▄▄▄█▄▄███▄▄▄████▄▄█▄█▄█▄▄▄█▄█▄▄▄▄████
█████████████████████████████████████████████████
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
html url: https://berty.tech/id#key=CiDPgh1reHYtP7Hr0gkiai1Fol2St2LOCa58k7hZ7aos7BIg2r9sW8RQu4VIxQU5svLQFz13ZOmYuiJO8X0Kug5Krvc&name=demo
Info
foo@bar:~$ berty info
{
  "protocol": {
    "process": {
      "version": "v2.203.1-dev.7+g55f966f6",
      "vcsRef": "55f966f6",
      "uptimeMs": "7",
      "userCpuTimeMs": "509",
      "systemCpuTimeMs": "72",
      "startedAt": "1604672821",
      "rlimitCur": "1024",
      "numGoroutine": "503",
      "nofile": "35",
      "numCpu": "12",
      "goVersion": "go1.15.3",
      "operatingSystem": "linux",
      "hostName": "REDACTED",
      "arch": "amd64",
      "rlimitMax": "1048576",
      "pid": "31258",
      "ppid": "31257",
      "priority": "20",
      "uid": "1000",
      "workingDir": "REDACTED",
      "systemUsername": "Hugo"
    },
    "p2p": {
      "connectedPeers": "6"
    },
    "orbitdb": {
      "accountMetadata": {
        "progress": "4",
        "maximum": "4"
      }
    }
  },
  "messenger": {
    "protocolInSameProcess": true,
    "db": {
      "accounts": "1"
    }
  }
}
--help
foo@bar:~$ berty -h
USAGE
  berty [global flags] <subcommand> [flags] [args...]

SUBCOMMANDS
  daemon        start a full Berty instance (Berty Protocol + Berty Messenger)
  mini          start a terminal-based mini berty client (not fully compatible with the app)
  banner        print the Berty banner of the day
  version       print software version
  info          display system info
  groupinit     initialize a new multi-member group
  share-invite  share invite link on your terminal or in the dev channel on Discord
  token-server  token server, a basic token server issuer without auth or logging
  repl-server   replication server
  peers         list peers
  export        export messenger data from the specified berty node

FLAGS
  -log.file ...                             if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*  zapfilter configuration
  -log.format color                         can be: json, console, color, light-console, light-color
  -log.service berty                        service name, used by the tracer
  -log.tracer ...                           specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger

ADVANCED
  -log.filters=':default: CUSTOM'  equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                   -> more info at https://github.com/moul/zapfilter

foo@bar:~$ berty daemon -h
USAGE
  berty [global flags] daemon [flags]

FLAGS
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -metrics.listener ...                           Metrics listener, will enable metrics
  -metrics.pedantic false                         Enable Metrics pedantic for debug
  -node.display-name hugo (cli)                   display name
  -node.listeners /ip4/127.0.0.1/tcp/9091/grpc    gRPC API listeners
  -node.no-notif false                            disable desktop notifications
  -node.rebuild-db false                          reconstruct messenger DB from OrbitDB logs
  -node.restore-export-path ...                   inits node from a specified export path
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -p2p.webui-listener :3999                       IPFS WebUI listener
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

foo@bar:~$ berty mini -h
USAGE
  berty [global flags] mini [flags]

FLAGS
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -metrics.listener ...                           Metrics listener, will enable metrics
  -metrics.pedantic false                         Enable Metrics pedantic for debug
  -mini.group ...                                 group to join, leave empty to create a new group
  -node.display-name hugo (cli)                   display name
  -node.listeners ...                             gRPC API listeners
  -node.no-notif false                            disable desktop notifications
  -node.rebuild-db false                          reconstruct messenger DB from OrbitDB logs
  -node.remote-addr ...                           remote Berty gRPC API address
  -node.restore-export-path ...                   inits node from a specified export path
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -p2p.webui-listener ...                         IPFS WebUI listener
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

foo@bar:~$ berty banner -h
USAGE
  berty banner [flags]

FLAGS
  -light false                              light mode
  -log.file ...                             if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*  zapfilter configuration
  -log.format color                         can be: json, console, color, light-console, light-color
  -log.service berty                        service name, used by the tracer
  -log.tracer ...                           specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -random false                             pick a random quote

ADVANCED
  -log.filters=':default: CUSTOM'  equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                   -> more info at https://github.com/moul/zapfilter

foo@bar:~$ berty version -h
USAGE
  berty version

ADVANCED
  -log.filters=':default: CUSTOM'  equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                   -> more info at https://github.com/moul/zapfilter

foo@bar:~$ berty info -h
USAGE
  berty [global flags] info [flags]

FLAGS
  -info.anonymize false                           anonymize output for sharing
  -info.refresh 0s                                refresh every DURATION (0: no refresh)
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -node.display-name hugo (cli)                   display name
  -node.no-notif false                            disable desktop notifications
  -node.rebuild-db false                          reconstruct messenger DB from OrbitDB logs
  -node.remote-addr ...                           remote Berty gRPC API address
  -node.restore-export-path ...                   inits node from a specified export path
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

foo@bar:~$ berty groupinit -h
USAGE
  berty groupinit

FLAGS
  -log.file ...                             if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*  zapfilter configuration
  -log.format color                         can be: json, console, color, light-console, light-color
  -log.service berty                        service name, used by the tracer
  -log.tracer ...                           specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger

ADVANCED
  -log.filters=':default: CUSTOM'  equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                   -> more info at https://github.com/moul/zapfilter

foo@bar:~$ berty share-invite -h
USAGE
  berty [global flags] share-invite [flags]

FLAGS
  -dev-channel false                              post qrcode on dev channel
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -no-term false                                  do not print the QR code in terminal
  -node.display-name hugo (cli)                   display name
  -node.no-notif false                            disable desktop notifications
  -node.rebuild-db false                          reconstruct messenger DB from OrbitDB logs
  -node.remote-addr ...                           remote Berty gRPC API address
  -node.restore-export-path ...                   inits node from a specified export path
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

foo@bar:~$ berty token-server -h
USAGE
  berty [global flags] token-server [flags]

FLAGS
  -auth.secret ...                          base64 encoded secret
  -auth.sk ...                              base64 encoded signature key
  -http.listener 127.0.0.1:8080             http listener
  -log.file ...                             if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*  zapfilter configuration
  -log.format color                         can be: json, console, color, light-console, light-color
  -log.service berty                        service name, used by the tracer
  -log.tracer ...                           specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -svc ...                                  comma separated list of supported services as name@ip:port

ADVANCED
  -log.filters=':default: CUSTOM'  equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                   -> more info at https://github.com/moul/zapfilter

foo@bar:~$ berty repl-server -h
USAGE
  berty [global flags] repl-server [flags]

FLAGS
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -node.auth-pk ...                               Protocol API Authentication Public Key (base64 encoded)
  -node.auth-secret ...                           Protocol API Authentication Secret (base64 encoded)
  -node.listeners /ip4/127.0.0.1/tcp/9091/grpc    gRPC API listeners
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -p2p.webui-listener :3999                       IPFS WebUI listener
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

foo@bar:~$ berty peers -h
USAGE
  berty [global flags] peers [flags]

FLAGS
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -node.remote-addr ...                           remote Berty gRPC API address
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -peers.refresh 1s                               refresh every DURATION (0: no refresh)
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

foo@bar:~$ berty export -h
USAGE
  berty [global flags] export [flags]

FLAGS
  -export-path ...                                path of the export tarball
  -log.file ...                                   if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:bty*,-*.grpc error+:*        zapfilter configuration
  -log.format color                               can be: json, console, color, light-console, light-color
  -log.service berty                              service name, used by the tracer
  -log.tracer ...                                 specify "stdout" to output tracing on stdout or <hostname:port> to trace on jaeger
  -node.display-name hugo (cli)                   display name
  -node.no-notif false                            disable desktop notifications
  -node.rebuild-db false                          reconstruct messenger DB from OrbitDB logs
  -node.remote-addr ...                           remote Berty gRPC API address
  -node.restore-export-path ...                   inits node from a specified export path
  -p2p.disable-ipfs-network false                 disable as much networking feature as possible, useful during development
  -p2p.ipfs-api-listeners ...                     IPFS API listeners
  -p2p.local-discovery true                       if true local discovery will be enabled
  -p2p.max-backoff 1m0s                           maximum p2p backoff duration
  -p2p.min-backoff 1s                             minimum p2p backoff duration
  -p2p.multipeer-connectivity false               if true Multipeer Connectivity will be enabled
  -p2p.rdvp :default:                             list of rendezvous point maddr, ":dev:" will add the default devs servers, ":none:" will disable rdvp
  -p2p.relay-hack false                           *temporary flag*; if set, Berty will use relays from the config optimistically
  -p2p.swarm-announce ...                         IPFS announce addrs
  -p2p.swarm-listeners :default:                  IPFS swarm listeners
  -p2p.swarm-no-announce ...                      IPFS exclude announce addrs
  -preset ...                                     applies various default values, see ADVANCED section below
  -store.dir /home/hugo/.config/berty-tech/berty  root datastore directory
  -store.fileio false                             enable FileIO Option, files will be loaded using standard I/O
  -store.inmem false                              disable datastore persistence
  -tor.binary-path ...                            if set berty will use this external tor binary instead of his builtin one
  -tor.mode disabled                              changes the behavior of libp2p regarding tor, see advanced help for more details

ADVANCED
  -log.filters=':default: CUSTOM'        equivalent to -log.filters='info+:bty*,-*.grpc error+:* CUSTOM'
                                         -> more info at https://github.com/moul/zapfilter
  -preset=performance                    better performance: current development defaults
  -preset=anonymity                      better privacy: -tor.mode=required -p2p.local-discovery=false -p2p.multipeer-connectivity=false
  -p2p.swarm-listeners=:default:,CUSTOM  equivalent to -p2p.swarm-listeners=/ip4/0.0.0.0/tcp/0,/ip6/::/tcp/0,/ip4/0.0.0.0/udp/0/quic,/ip6/::/udp/0/quic,CUSTOM
  -p2p.rdvp=:default:,CUSTOM             equivalent to -p2p.rdvp=/ip4/51.159.21.214/tcp/4040/p2p/QmdT7Amhhn...,CUSTOM
                                         -> full list available at https://github.com/berty/berty/tree/master/config)
  -tor.mode=disabled                     tor is completely disabled
  -tor.mode=optional                     tor is added to the list of existing transports and can be used to contact other tor-ready nodes
  -tor.mode=required                     tor is the only available transport; you can only communicate with other tor-ready nodes

Other Binaries

rdvp
foo@bar:~$ rdvp -h
USAGE
  rdvp [global flags] <subcommand>

SUBCOMMANDS
  serve   
  genkey  

FLAGS
  -log.file stderr      if specified, will log everything in JSON into a file and nothing on stderr
  -log.filters info+:*  logged namespaces
  -log.format color     if specified, will override default log format

foo@bar:~$ rdvp serve -h
USAGE
  rdvp [global flags] serve [flags]

EXAMPLE
  rdvp genkey > rdvp.key
  rdvp serve -pk `cat rdvp.key` -db ./rdvp-store

FLAGS
  -announce ...                                        addrs that will be announce by this server
  -db :memory:                                         rdvp sqlite URN
  -l /ip4/0.0.0.0/tcp/4040,/ip4/0.0.0.0/udp/4141/quic  lists of listeners of (m)addrs separate by a comma
  -metrics ...                                         metrics listener, if empty will disable metrics
  -pk ...                                              private key (generated by `rdvp genkey`)

foo@bar:~$ rdvp genkey -h
USAGE
  genkey

FLAGS
  -length 2048   The length (in bits) of the key generated.
  -type Ed25519  Type of the private key generated, one of : Ed25519, ECDSA, Secp256k1, RSA
betabot
foo@bar:~$ betabot -h
Usage of betabot:
  -addr string
    	remote 'berty daemon' address (default "127.0.0.1:9091")
  -display-name string
    	bot's display name (default "hugo (betabot)")
  -staff-conversation-link string
    	link of the staff's conversation to join
  -store string
    	store file path (default "./betabot.store")

Directories

Path Synopsis
cmd
berty
Berty is the main CLI entrypoint to manage the Berty ecosystem (client, server, relay, dev).
 Berty is the main CLI entrypoint to manage the Berty ecosystem (client, server, relay, dev).
berty-doctor
berty-integration
berty/mini
Package mini contains main helpers to start a term-based Berty mini client.
 Package mini contains main helpers to start a term-based Berty mini client.
betabot
rdvp
rdvp is a service to hold Berty's rendezvous point for faster peer discovery.
 rdvp is a service to hold Berty's rendezvous point for faster peer discovery.
testbot
framework
bertybridge
Package bertybridge is the main gomobile entrypoint, used to generate iOS and Android frameworks.
 Package bertybridge is the main gomobile entrypoint, used to generate iOS and Android frameworks.
internal
config
file generated.
 file generated.
cryptoutil
Package cryptoutil contains generic & stateless crypto helpers.
 Package cryptoutil contains generic & stateless crypto helpers.
discordlog
discordlog is an unsafe package used during development to log info directly on the Berty's Discord server.
 discordlog is an unsafe package used during development to log info directly on the Berty's Discord server.
grpcutil
Package grpcutil contains gRPC lazy codecs, messages and a buf-based listener.
 Package grpcutil contains gRPC lazy codecs, messages and a buf-based listener.
handshake
Package handshake implements a capability-based handshake.
 Package handshake implements a capability-based handshake.
initutil
ipfsutil
Package ipfsutil contains helpers around IPFS (logging, datastore, networking, core API, ...).
 Package ipfsutil contains helpers around IPFS (logging, datastore, networking, core API, ...).
lifecycle
logutil
multipeer-connectivity-driver
notification
packingutil
proximity-transport
sysutil
testutil
Package testutil contains testing helpers (logging, slow skipping).
 Package testutil contains testing helpers (logging, slow skipping).
tinder
Package tinder is a multi-driver service backed by a cache.
 Package tinder is a multi-driver service backed by a cache.
tools
Package tools ensures that `go mod` detect some required dependencies.
 Package tools ensures that `go mod` detect some required dependencies.
tracer
pkg
assets
banner
Package banner generates ASCII picture of the Berty logo with a message.
 Package banner generates ASCII picture of the Berty logo with a message.
bertyaccount
bertybot
bertymessenger
Package bertymessenger is a reverse proxy.
 Package bertymessenger is a reverse proxy.
bertyprotocol
Package bertyprotocol is a reverse proxy.
 Package bertyprotocol is a reverse proxy.
bertytypes
This package is generated with Protobuf.
 This package is generated with Protobuf.
bertyversion
errcode
Package errcode contains the list of Berty error codes.
 Package errcode contains the list of Berty error codes.
tempdir
username

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.