https://akhoury6.github.io/rbcli/tutorial/ Recent content in Tutorial on RBCli Documentation Hugo -- gohugo.io en-us Thu, 20 Jun 2019 15:08:08 -0400 https://akhoury6.github.io/rbcli/tutorial/10-getting_started/ Thu, 20 Jun 2019 15:07:21 -0400 https://akhoury6.github.io/rbcli/tutorial/10-getting_started/ Welcome to the RBCli getting started tutorial! In this tutorial we’re going to cover the basics of RBCli and get a simple application up and running. It should take you between 30-60 minutes to complete, depending on your skill level with Ruby. As you go throught the tutorial, you can either use the Next and Back buttons on the page to navigate, or use the menu directly. Supported Ruby Versions You’ll need Ruby installed before you can use RBCli. https://akhoury6.github.io/rbcli/tutorial/20-project_layout/ Thu, 20 Jun 2019 15:07:21 -0400 https://akhoury6.github.io/rbcli/tutorial/20-project_layout/ Now we will learn about what an RBCli project looks like and how to start using it. Project Initialization Types RBCli can initialize a tool in three different modes: Project Mode (default) Mini Mode Micro Mode Project Mode If you’ve been following along with the tutorial, you’ve already seen Project Mode. An RBCli Project consists of several folders, each of which has a specific function. The RBCli framework handles loading and parsing the code automatically. https://akhoury6.github.io/rbcli/tutorial/30-your_first_command/ Thu, 20 Jun 2019 15:07:21 -0400 https://akhoury6.github.io/rbcli/tutorial/30-your_first_command/ Creating the Command Creating the command is straightforward: rbcli command --name=list #or rbcli command -n list And there you have it! Now you can try out your command by typing: ./exe/mytool list Congrats! You should now see a generic output listing the values of several variables. We’ll get into what they mean in a bit, but first, let’s make the tool’s execution a bit easier. Now that you know your way around a project, its time to create your first command! https://akhoury6.github.io/rbcli/tutorial/40-options_parameters_and_arguments/ Thu, 20 Jun 2019 15:07:21 -0400 https://akhoury6.github.io/rbcli/tutorial/40-options_parameters_and_arguments/ If you’re already an experienced coder, you can jump to the last section of this document, the Simplified Reference (TLDR) Command Line Structure In the previous section, you saw two parts of the RBCli command line structure - the executable followed by the command. However, RBCli is capable of more complex interaction. The structure is as follows: toolname [options] command [parameters] argument1 argument2... Options are command line parameters such as -f, or --force. https://akhoury6.github.io/rbcli/tutorial/50-publishing/ Thu, 20 Jun 2019 15:07:21 -0400 https://akhoury6.github.io/rbcli/tutorial/50-publishing/ RBCli creates projects designed to be easily distributed via either source control or as a gem. We’ll go over both methods. Common Tasks Regardless of where you are publishing, certain tasks need to be accomplished. Namely, preparing the gemspec and the README. In both files the items that need changing are pretty obvious – you’ll need to fill out your name, email, etc, and replace the placeholder text in the README with something useful to your users.