Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.4 KB

README.md

File metadata and controls

28 lines (24 loc) · 1.4 KB
Raw

clibox

a simple CLI skeleton and sandbox to get started with urbit CLIs

  • Learn more about urbit Command Line Interfaces here.
  • Learn more about parsing commands with Hoon here.
  • Learn more about the terminal driver vane %dill here.
  • See other skeletons.

Files to mess around with:

  • /app/clibox.hoon
  • /sur/clibox.hoon
  • /lib/command-parser.hoon
  • /mar/clibox/action.hoon

Installation

  1. Clone this repo.
  2. Boot up a ship (fakezod or moon or whatever you use).
  3. |new-desk %clibox to create a new desk called `%clibox.
  4. |mount %clibox to access the %clibox desk from the unix command line.
  5. At the unix command line rm -rf [ship-name]/clibox/* to empty out the contents of the desk.
  6. cp -r clibox/* [ship-name]/clibox to copy the contents of this repo into your new desk.
  7. At the dojo command line |commit %clibox.
  8. Install with |install our %clibox.
  9. Link the command line app with |link %clibox.
  10. Switch through command line apps with Ctrl+X until you see the ~zod:clibox prompt.
  11. Type add ~zod and hit ENTER to add ~zod to a list of ships in the state.
  12. Type lis and hit ENTER to print the list of ships to the terminal.