Skip to content

Update --help descriptions and flags #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jonny-Ringo wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update --help descriptions and flags #488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d548c32
Update help documentation and command descriptions
Jonny-Ringo Feb 27, 2026
8157133
Change install gateway to arweave.net
Jonny-Ringo Feb 27, 2026
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
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:

- name: 🤖 Setup ao dev-cli
run: |
curl -fsSL https://install_ao.g8way.io | bash
curl -fsSL https://install_ao.arweave.net | bash

- name: 📥 Download Process deps
working-directory: process
Expand Down Expand Up @@ -102,7 +102,7 @@ jobs:

# - name: 🤖 Setup ao dev-cli
# run: |
# curl -fsSL https://install_ao.g8way.io | bash
# curl -fsSL https://install_ao.arweave.net | bash

# - name: 📥 Download deps
# working-directory: process
Expand Down Expand Up @@ -144,7 +144,7 @@ jobs:

- name: 🤖 Setup ao dev-cli
run: |
curl -fsSL https://install_ao.g8way.io | bash
curl -fsSL https://install_ao.arweave.net | bash

- name: 👀 Env
run: |
Expand Down
20 changes: 10 additions & 10 deletions src/services/help.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ export function replHelp() {
printWithBorder([
chalk.gray('AOS Client Functions'),
'newline',
chalk.gray('Documentation: ') + chalk.green('https://cookbook_ao.g8way.io'),
chalk.gray('Documentation: ') + chalk.green('https://cookbook_ao.arweave.net'),
'newline',
chalk.gray('Client Commands:'),
'newline',
chalk.green('.load [file]') + ' Loads local Lua file into the process',
chalk.green('.load-blueprint [blueprint]') + ' Loads a blueprint from the blueprints repository',
chalk.green('.monitor') + ' Starts monitoring cron messages for this process',
chalk.green('.unmonitor') + ' Stops monitoring cron messages for this process',
chalk.green('.monitor') + ' [Legacynet]Starts monitoring cron messages for this process',
chalk.green('.unmonitor') + ' [Legacynet]Stops monitoring cron messages for this process',
chalk.green('.editor') + ' Simple code editor for writing multi-line Lua expressions',
chalk.green('.dryrun') + ' Toggle dryrun mode that sends every command as a dryrun and never saves memory',
chalk.green('.dryrun') + ' [Legacynet]Toggle dryrun mode that sends every command as a dryrun and never saves memory',
chalk.green('.exit') + ' Close the client',
chalk.green('.help') + ' Print this help screen',
'newline',
Expand All @@ -30,14 +30,14 @@ export function help() {
printWithBorder([
chalk.gray('Welcome to the AOS client! AOS allows you to build and interact with AO processes.'),
'newline',
chalk.gray('Documentation: ') + chalk.green('https://cookbook_ao.g8way.io'),
chalk.gray('Documentation: ') + chalk.green('https://cookbook_ao.arweave.net'),
'newline',
chalk.gray('Options:'),
'newline',
chalk.green('[name]') + ' The name of the process you want to spawn or connect to. If you do not specify a name then "default" will be used.',
'newline',
chalk.green('--wallet [file]') + ' Set the wallet to interact with your process. By Default one is created for you at ~/.aos.json',
chalk.green('--mainnet [mainnet-node-url]') + ' Set the AO Mainnet (HyperBEAM) URL to connect to.',
chalk.green('--url [mainnet-node-url]') + ' Set the AO Mainnet HyperBEAM nOde URL to connect to.',
chalk.green('--watch=[process]') + ' Watch the console of a process, even if you are not the owner.',
chalk.green('--load [file]') + ' Load Lua source file(s) into your process.',
chalk.green('--run "<lua code>"') + ' Execute a single Lua expression non-interactively and exit (suppressing splash output).',
Expand All @@ -46,12 +46,12 @@ export function help() {
chalk.green('--tag-name [name]') + ' Set a tag name for your process when spawning. Pair with --tag-value.',
chalk.green('--tag-value [value]') + ' Set a tag value for your process when spawning. Pair with --tag-name.',
chalk.green('--module=[TXID]') + ' The module ID to use when spawning a process.',
chalk.green('--cron [frequency]-[unit]') + ' Setup automated messages for your process for a given interval. For example: 1-minute, 30-seconds.',
chalk.green('--monitor') + ' Monitor and push cron outbox messages and spawns.',
chalk.green('--cron [frequency]-[unit]') + ' [Legacynet]Setup automated messages for your process for a given interval. For example: 1-minute, 30-seconds.',
chalk.green('--monitor') + ' [Legacynet]Monitor and push cron outbox messages and spawns.',
chalk.green('--get-blueprints [dir]') + ' Download blueprint Lua scripts to your current working directory.',
chalk.green('--gateway-url') + ' Set Arweave gateway location.',
chalk.green('--cu-url') + ' Set Compute Unit location.',
chalk.green('--mu-url') + ' Set Messenger Unit location',
chalk.green('--cu-url') + ' [Legacynet]Set Compute Unit location.',
chalk.green('--mu-url') + ' [Legacynet]Set Messenger Unit location',
chalk.green('--sqlite') + ' Spawn AOS process using sqlite3 AOS Module ie [[ aos [name] --sqlite ]]',
chalk.green('--version') + ' Show AOS client version number',
chalk.green('--help') + ' Shows this help page.',
Expand Down
Loading