Skip to content

Commit

Permalink
chore: generate unified documentation, remove timestamp
Browse files Browse the repository at this point in the history
  • Loading branch information
@PhearZero
PhearZero committed Jan 28, 2025
1 parent 85e056c commit b5a001b
Show file tree
Hide file tree
Showing 16 changed files with 454 additions and 28 deletions.
295 changes: 295 additions & 0 deletions .devportal/nodekit.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,295 @@
---
title: "nodekit"
---
## Synopsis
Manage Algorand nodes from the command line

Overview:
Welcome to NodeKit, a TUI for managing Algorand nodes.
A one stop shop for managing Algorand nodes, including node creation, configuration, and management.

Note: This is still a work in progress. Expect bugs and rough edges.

```
nodekit [flags]
```

### Options

```
-d, --datadir string Data directory for the node
-h, --help help for nodekit
-n, --no-incentives Disable setting incentive eligibility fees
```

# Commands
## bootstrap
Initialize a fresh node

Overview:
Get up and running with a fresh Algorand node.
Uses the local package manager to install Algorand, and then starts the node and preforms a Fast-Catchup.

Note: This command only supports the default data directory, /var/lib/algorand

```
nodekit bootstrap [flags]
```

#### Options

```
-h, --help help for bootstrap
```

## catchup
Fast-Catchup is a feature that allows your node to catch up to the network faster than normal.

Overview:
The entire process should sync a node in minutes rather than hours or days.
Actual sync times may vary depending on the number of accounts, number of blocks and the network.

Note: Not all networks support Fast-Catchup.

```
nodekit catchup [flags]
```

#### Options

```
-d, --datadir string Data directory for the node
-h, --help help for catchup
```

## catchup debug
Display debug information for Fast-Catchup.

Overview:
This information is useful for debugging fast-catchup issues.

Note: Not all networks support Fast-Catchup.

```
nodekit catchup debug [flags]
```

#### Options

```
-d, --datadir string Data directory for the node
-h, --help help for debug
```

## catchup start
Catchup the node to the latest catchpoint.

Overview:
Starting a catchup will sync the node to the latest catchpoint.
Actual sync times may vary depending on the number of accounts, number of blocks and the network.

Note: Not all networks support Fast-Catchup.

```
nodekit catchup start [flags]
```

#### Options

```
-d, --datadir string Data directory for the node
-h, --help help for start
```

## catchup stop
Stop a fast catchup

Overview:
Stop an active Fast-Catchup. This will abort the catchup process if one has started

Note: Not all networks support Fast-Catchup.

```
nodekit catchup stop [flags]
```

#### Options

```
-d, --datadir string Data directory for the node
-h, --help help for stop
```

## configure
Change settings on the system (WIP)

Overview:
Tool for inspecting and updating the Algorand daemon's config.json and service files

Note: This is still a work in progress. Expect bugs and rough edges.

#### Options

```
-h, --help help for configure
```

## configure service
Install service files for the Algorand daemon.

Overview:
Ensuring that the Algorand daemon is installed and running as a service.

Note: This is still a work in progress. Expect bugs and rough edges.

```
nodekit configure service [flags]
```

#### Options

```
-h, --help help for service
```

## debug
Display debugging information

Overview:
Prints the known state of the nodekit
Checks various paths and configurations to present useful information for bug reports.


```
nodekit debug [flags]
```

#### Options

```
-d, --datadir string Data directory for the node
-h, --help help for debug
```

## install
Install the node daemon

Overview:
Configures the local package manager and installs the algorand daemon on your local machine


```
nodekit install [flags]
```

#### Options

```
-f, --force forcefully install the node
-h, --help help for install
```

## start
Start the node daemon

Overview:
Start the Algorand daemon on your local machine if it is not already running. Optionally, the daemon can be forcefully started.

This requires the daemon to be installed on your system.

```
nodekit start [flags]
```

#### Options

```
-f, --force forcefully start the node
-h, --help help for start
```

## stop
Stop the node daemon

Overview:
Stops the Algorand daemon on your local machine. Optionally, the daemon can be forcefully stopped.

This requires the daemon to be installed on your system.

```
nodekit stop [flags]
```

#### Options

```
-f, --force forcefully stop the node
-h, --help help for stop
```

## uninstall
Uninstall the node daemon

Overview:
Uninstall Algorand node (Algod) and other binaries on your system installed by this tool.

This requires the daemon to be installed on your system.

```
nodekit uninstall [flags]
```

#### Options

```
-f, --force forcefully uninstall the node
-h, --help help for uninstall
```

## upgrade
Upgrade the node daemon

Overview:
Upgrade Algorand packages if it was installed with package manager.

This requires the daemon to be installed on your system.

```
nodekit upgrade [flags]
```

#### Options

```
-h, --help help for upgrade
```

###### Auto generated by spf13/cobra on 28-Jan-2025
1 change: 0 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ nodekit [flags]
* [nodekit uninstall](/man/nodekit_uninstall.md) - Uninstall the node daemon
* [nodekit upgrade](/man/nodekit_upgrade.md) - Upgrade the node daemon

###### Auto generated by spf13/cobra on 22-Jan-2025

### Installing

Expand Down
1 change: 0 additions & 1 deletion man/nodekit_bootstrap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit bootstrap [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_catchup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ nodekit catchup [flags]
* [nodekit catchup start](/man/nodekit_catchup_start.md) - Get the latest catchpoint and start catching up.
* [nodekit catchup stop](/man/nodekit_catchup_stop.md) - Stop a fast catchup

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_catchup_debug.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit catchup debug [flags]

* [nodekit catchup](/man/nodekit_catchup.md) - Manage Fast-Catchup for your node

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_catchup_start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ nodekit catchup start [flags]

* [nodekit catchup](/man/nodekit_catchup.md) - Manage Fast-Catchup for your node

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_catchup_stop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit catchup stop [flags]

* [nodekit catchup](/man/nodekit_catchup.md) - Manage Fast-Catchup for your node

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_configure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,3 @@ Note: This is still a work in progress. Expect bugs and rough edges.
* [nodekit](/README.md) - Manage Algorand nodes from the command line
* [nodekit configure service](/man/nodekit_configure_service.md) - Install service files for the Algorand daemon.

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_configure_service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ nodekit configure service [flags]

* [nodekit configure](/man/nodekit_configure.md) - Change settings on the system (WIP)

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_debug.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit debug [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ nodekit install [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit start [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_stop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit stop [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_uninstall.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ nodekit uninstall [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
1 change: 0 additions & 1 deletion man/nodekit_upgrade.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ nodekit upgrade [flags]

* [nodekit](/README.md) - Manage Algorand nodes from the command line

###### Auto generated by spf13/cobra on 7-Jan-2025
Loading

0 comments on commit b5a001b

Please sign in to comment.