autonomousorganization
/
ao-cli
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
An interactive command-line interface (CLI) tool to help you install, use, and administer an AO instance.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
21 Commits
1 Branch
0 Tags
2.5 MiB
 
 
 
Tree: 90b22aa611
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '90b22aa611'
${ noResults }
ao-cli/README.md

2.5 KiB
Raw Blame History

ao-cli

ao-cli (alias ao) is a command-line interface (CLI) that helps you install, use, and configure the Autonomous Organization (AO). Command-line social networking for hackers.

To run immediately:

npx @autonomousorganization/ao-cli

To install:

npm i -g @autonomousorganization/ao-cli

Then you can run with ao-cli. (In the menus you will find an option to add ao as an alias.)

Features

These features work right now:

  • Browse the AO User Manual and automatically download and keep it updated
  • Manages your AO configuration file for you
  • Wraps the functionality of (some of) Zen's Alchemy suite of scripts (system configuration, AO installation)
  • ao-cli can self-update to the newest version
  • Run AO unit tests to verify the up-to-spec functioning of the system's running AO API server

Upcoming Features

These features are planned and many are mocked up in the menus:

  • Join the AO .onion bootstrapping network and find public AO chatrooms p2p over tor
  • Operate essential AO client features (like creating and sending cards p2p via tor)
  • Easily install and configure your AO server installation
  • Easily use hardware-owner-only god-mode features for your AO server including resetting any password or deleting any member
  • Easily monitor your AO server status and start/stop the service
  • Easily switch between serving different AO frontends: ao-svelte, ao-3 (Vue), or ao-react
  • Easily install/uninstall and turn on/off option AO features
  • Easily update all your remote AOs at once
  • Easily install your preferred flavor of Unix on any unsecured Windows computer given its IP address (j/k)
  • Full interactive wizard to walk you through setting up and connecting new AO hardware resources to your AO server

Important Locations

  • ~/.ao/ Your AO saved data folder
  • ~/.ao/database.sqlite3 Location of your AO database (copy to back up)
  • ~/ao-cli/ Typical location for ao-cli
  • ~/ao-svelte/ Typical location for ao-svelte
  • ~/ao-3/ Typical location for ao-3
  • ~/.ao/ao-manual/ Typical location of the AO manual (Markdown files)
  • ~/Alchemy/ Typical location of Zen's Alchemy

Version History

  • 0.0.8 Added self-update feature and --version/-v arg
  • 0.0.6 User manual downloads and updates automatically from official ao-manual repo
  • 0.0.5 Added browsable manual
  • 0.0.1 Menus prototyped