Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/cli/control/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Control",
"position": 9
}
34 changes: 34 additions & 0 deletions docs/cli/control/getmemoryinfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: getmemoryinfo
sidebar_label: getmemoryinfo
description: "Syscoin Core CLI reference: getmemoryinfo"
---

# `getmemoryinfo`

Returns an object containing information about memory usage.

## Synopsis

```
getmemoryinfo ( "mode" )
```

## Arguments

```
1. mode (string, optional, default="stats") determines what kind of information is returned.
- "stats" returns general statistics about memory usage in the daemon.
- "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc).
```

## Examples

```
> syscoin-cli getmemoryinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getmemoryinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/node.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/node.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
41 changes: 41 additions & 0 deletions docs/cli/control/getrpcinfo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: getrpcinfo
sidebar_label: getrpcinfo
description: "Syscoin Core CLI reference: getrpcinfo"
---

# `getrpcinfo`

Returns details of the RPC server.

## Synopsis

```
getrpcinfo
```

## Result

```
{ (json object)
"active_commands" : [ (json array) All active commands
{ (json object) Information about an active command
"method" : "str", (string) The name of the RPC command
"duration" : n (numeric) The running time in microseconds
},
...
],
"logpath" : "str" (string) The complete file path to the debug log
}
```

## Examples

```
> syscoin-cli getrpcinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getrpcinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
31 changes: 31 additions & 0 deletions docs/cli/control/help.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: help
sidebar_label: help
description: "Syscoin Core CLI reference: help"
---

# `help`

List all commands, or get help for a specified command.

## Synopsis

```
help ( "command" )
```

## Arguments

```
1. command (string, optional, default=all commands) The command to get help on
```

## Result

```
"str" (string) The help text
```

---

*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
58 changes: 58 additions & 0 deletions docs/cli/control/logging.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: logging
sidebar_label: logging
description: "Syscoin Core CLI reference: logging"
---

# `logging`

Gets and sets the logging configuration.
When called without an argument, returns the list of categories with status that are currently being debug logged or not.
When called with arguments, adds or removes categories from debug logging and return the lists above.
The arguments are evaluated in order "include", "exclude".
If an item is both included and excluded, it will thus end up being excluded.
The valid logging categories are: addrman, bench, blockstorage, chainlocks, cmpctblock, coindb, estimatefee, gobject, http, i2p, ipc, leveldb, libevent, llmq, llmq-dkg, llmq-sigs, mempool, mempoolrej, mnlist, mnpayments, mnsync, net, netconn, proxy, prune, qt, rand, reindex, rpc, scan, selectcoins, spork, syscoin, tor, txpackages, txreconciliation, util, validation, walletdb, zmq
In addition, the following are available as category names with special meanings:
- "all", "1" : represent all logging categories.
- "none", "0" : even if other logging categories are specified, ignore all of them.

## Synopsis

```
logging ( ["include_category",...] ["exclude_category",...] )
```

## Arguments

```
1. include (json array, optional) The categories to add to debug logging
[
"include_category", (string) the valid logging category
...
]
2. exclude (json array, optional) The categories to remove from debug logging
[
"exclude_category", (string) the valid logging category
...
]
```

## Result

```
{ (json object) keys are the logging categories, and values indicates its status
"category" : true|false, (boolean) if being debug logged or not. false:inactive, true:active
...
}
```

## Examples

```
> syscoin-cli logging "[\"all\"]" "[\"http\"]"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "logging", "params": [["all"], ["libevent"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/node.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/node.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
25 changes: 25 additions & 0 deletions docs/cli/control/stop.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: stop
sidebar_label: stop
description: "Syscoin Core CLI reference: stop"
---

# `stop`

Request a graceful shutdown of Syscoin Core.

## Synopsis

```
stop
```

## Result

```
"str" (string) A string with the content 'Syscoin Core stopping'
```

---

*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
32 changes: 32 additions & 0 deletions docs/cli/control/uptime.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: uptime
sidebar_label: uptime
description: "Syscoin Core CLI reference: uptime"
---

# `uptime`

Returns the total uptime of the server.

## Synopsis

```
uptime
```

## Result

```
n (numeric) The number of seconds that the server has been running
```

## Examples

```
> syscoin-cli uptime
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "uptime", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/rpc/server.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/server.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
4 changes: 4 additions & 0 deletions docs/cli/governancewallet/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Governance Wallet",
"position": 15
}
32 changes: 32 additions & 0 deletions docs/cli/governancewallet/gobject_list_prepared.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: gobject_list_prepared
sidebar_label: gobject_list_prepared
description: "Syscoin Core CLI reference: gobject_list_prepared"
---

# `gobject_list_prepared`

Returns a list of governance objects prepared by this wallet with "gobject_prepare" sorted by their creation time.

## Synopsis

```
gobject_list_prepared ( count )
```

## Arguments

```
1. count (numeric, optional) Maximum number of objects to return.
```

## Examples

```
> syscoin-cli gobject_list_prepared
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_list_prepared", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
43 changes: 43 additions & 0 deletions docs/cli/governancewallet/gobject_prepare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: gobject_prepare
sidebar_label: gobject_prepare
description: "Syscoin Core CLI reference: gobject_prepare"
---

# `gobject_prepare`

Prepare governance object by signing and creating tx.

## Synopsis

```
gobject_prepare "parentHash" revision time "dataHex" ( "outputHash" outputIndex )
```

## Arguments

```
1. parentHash (string, required) Hash of the parent object, "0" is root.
2. revision (numeric, required) Object revision in the system.
3. time (numeric, required) Time this object was created.
4. dataHex (string, required) Data in hex string form.
5. outputHash (string, optional) The single output to submit the proposal fee from.
6. outputIndex (numeric, optional) The output index.
```

## Result

```
"hex" (string) txid
```

## Examples

```
> syscoin-cli gobject_prepare
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_prepare", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
35 changes: 35 additions & 0 deletions docs/cli/governancewallet/gobject_vote_alias.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: gobject_vote_alias
sidebar_label: gobject_vote_alias
description: "Syscoin Core CLI reference: gobject_vote_alias"
---

# `gobject_vote_alias`

Vote on a governance object by masternode's voting key (if present in local wallet).

## Synopsis

```
gobject_vote_alias "governanceHash" "vote" "voteOutome" "protxHash"
```

## Arguments

```
1. governanceHash (string, required) Hash of the governance object.
2. vote (string, required) Vote, possible values: [funding|valid|delete|endorsed].
3. voteOutome (string, required) Vote outcome, possible values: [yes|no|abstain].
4. protxHash (string, required) Masternode's proTxHash.
```

## Examples

```
> syscoin-cli gobject_vote_alias
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_vote_alias", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
34 changes: 34 additions & 0 deletions docs/cli/governancewallet/gobject_vote_many.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: gobject_vote_many
sidebar_label: gobject_vote_many
description: "Syscoin Core CLI reference: gobject_vote_many"
---

# `gobject_vote_many`

Vote on a governance object by all masternodes for which the voting key is present in the local wallet.

## Synopsis

```
gobject_vote_many "governanceHash" "vote" "voteOutome"
```

## Arguments

```
1. governanceHash (string, required) Hash of the governance object.
2. vote (string, required) Vote, possible values: [funding|valid|delete|endorsed].
3. voteOutome (string, required) Vote outcome, possible values: [yes|no|abstain].
```

## Examples

```
> syscoin-cli gobject_vote_many
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gobject_vote_many", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/
```

---

*Source: [src/wallet/rpcgovernance.cpp](https://github.com/syscoin/syscoin/blob/master/src/wallet/rpcgovernance.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-21.*
4 changes: 4 additions & 0 deletions docs/cli/util/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Util",
"position": 8
}
Loading