console

The console command starts the node and also a console session. Like the start command, it will attempt to connect the node to the network.
The console provides a JavaScript environment for executing custom scripts that allow developers and users to perform operations not natively supported by Kit.
The JavaScript context is loaded with modules that allow you to build complex scripts. See the console section to learn about the available modules.
Usage
1
kit console [options]
Copied!
1
Start a JavaScript console and connect the node to the network
2
​
3
Usage:
4
  kit console [flags]
5
​
6
Flags:
7
      --dht.addpeer string             Register bootstrap peers for joining the DHT network
8
      --dht.address string             Set the DHT listening address (default "127.0.0.1:9003")
9
      --dht.on                         Run the DHT service and join the network (default true)
10
  -h, --help                           help for console
11
      --node.addpeer string            connect to one or more persistent node
12
      --node.address string            Set the node's p2p listening address (default "127.0.0.1:9000")
13
      --node.exts strings              Specify an extension to run on startup
14
      --node.extsargs stringToString   Specify arguments for extensions (default [])
15
      --node.validator                 Run the node in validator mode
16
  -t, --repo.track strings             Specify one or more repositories to track
17
  -u, --repo.untrack strings           Untrack one or more repositories
18
  -x, --repo.untrackall                Untrack all previously tracked repositories
19
      --rpc.authpubmethod              Enable RPC authentication for non-private methods
20
      --rpc.disableauth                Disable RPC authentication
21
      --rpc.on                         Start the RPC service
22
      --rpc.password string            Set the RPC password
23
      --rpc.tmaddress string           Set tendermint RPC listening address (default "127.0.0.1:9001")
24
      --rpc.user string                Set the RPC username
Copied!
Options
Node
--node.address - The address the node will bind and listen to for incoming connections.
--node.addpeer - Provide a comma-separated list of node addresses to connect to.
--node.exts - Specify an extension to run when the node starts.
--node.extsargs - Provide arguments for extensions.
--node.validator - Run the node in validator mode. This will prevent your node from taking part in host operations. 
Remote
--remote.address - The address where the remote server will listen for git requests.
RPC
--rpc.on - Starts the RPC server on the default address. By default, the server is not started.
--remote.address - The address where the RPC server will listen for incoming JSON-RPC 2.0 requests.
--rpc.authpubmethod - Force the RPC server to require authorization check for calls targeting public RPC methods.
--rpc.disableauth - Prevents the RPC server from performing authorization checks of incoming requests.
--rpc.user - The RPC user to use for basic authorization.
--rpc.password - The RPC password to use for basic authorization.
--rpc.tmaddress - The address where the Tendermint RPC server listens for incoming RPC requests coming from Kit. 
DHT
--dht.on - Starts the DHT server. It will connect to the DHT seed nodes embedded into the client. 
--dht.address - Set the address where the DHT will bind to and listen for incoming connections.
--dht.addpeer - Provide a comma-separated list of DHT node address to connect to. 
Example
Bash
Output
1
kit console \
2
    --rpc.on \
3
    --remote.address=:6000 \
4
    --rpc.user admin \
5
    --rpc.password admin \
6
    --rpc.on \
7
    --dht.addpeer=/ip4/127.0.0.1/tcp/7003/p2p/12D3KooWENHGhd6853kiLQLo5g7zLkMrdbma5K2CYwdSpbNCNk3t
Copied!
1
Welcome to the JavaScript Console!
2
  Client:v0.0.1, Protocol:1, Commit:576xhbg8r76..dhf88t, Go: 1.4
3
   type '.exit' to exit console
4
  
5
>
Copied!

KIT CLI Reference - Previous

start

Next - KIT CLI Reference

attach

Last modified 1yr ago

Copy link

Contents