The CodeUnion command-line tool is meant to be used in conjunction with CodeUnion's curriculum. Think of it as your "learning sherpa."
To install the CodeUnion command-line tool, run
$ gem install codeunion
If you're using rbenv to manage your Ruby environment, make sure to run
$ rbenv rehash
after you install the gem. This is required for rbenv to pick up any new executables installed by a gem, including ours.
Once you've installed the gem, you will be able to run the codeunion command:
$ codeunion
To run a particular subcommand, add it to the codeunion base command. For example, to use the search command you would run:
$ codeunion search [your search query]
You can see a help window for any subcommand by appending a -h or --help flag:
$ codeunion search -h
Usage: codeunion search [options] <terms>
Options:
-c, --category CATEGORY Display config variable NAME
-h, --help Print this help message
Read and write configuration for the CodeUnion command-line tool.
Example usage:
# Set the feedback.repository value
$ codeunion config set feedback.repository codeunion/feedback-requests-web-fundamentals
# Get the feedback.repository value
$ codeunion config get feedback.repository
codeunion/feedback-requests-web-fundamentals
Request feedback on your code.
Feedback requests require a URL for a specific commit or a pull request.
Example usage:
$ codeunion feedback request https://github.com/codeunion/overheard-server/commit/0edb7866809620013d4a3c2d3b5bea57b12bf255
This will add an issue to the feedback repository specified in the config variable feedback.repository.
To use the feedback command, you will need to set the following configuration variables:
github.access_token
Allows the tool to interact with GitHub as you. See this article for more information.
You can use the default OAuth scop
7E1C
es. As of this writing those are: repo, public_repo, gist, and user.
feedback.repository
URL of the GitHub repository to submit feedback requests in. For example: https://github.com/codeunion/feedback-requests-web-fundamentals
If you don't know which repository to use, see your workshop's base repository or ask your instructor.
Search the repositories in the CodeUnion curriculum.
Example usage:
$ codeunion search html
Project: social-wall
Your First Web Application
https://github.com/codeunion/social-wall
tags:
Excerpt: HTML templating and ERB - Deploying an application to Heroku
The following video tutorials are all based...
[...]
You can narrow your searches by category with the --category flag.
$ codeunion search html --category example
Or you can use the alias commands to narrow your search to either projects or examples.
$ codeunion examples html
...and...
$ codeunion projects html
The CodeUnion client targets Ruby 1.9.3, 2.0, and 2.1. Assuming you have homebrew installed already:
make install # Installs npm, wach, rbenv, ruby-build and ruby 1.9.3, 2.0
# and 2.1
make unit-test # Runs the unit tests against all ruby versions. Thread-safe.
make feature-test # Runs the feature tests against all ruby versions. Not-thread-safe.
make test # Runs unit and feature tests against all ruby versions
The command-line tool is organized into subcommands, a la git. If we were to run this command, for example
$ codeunion waffles
the CodeUnion tool would look for an executable named codeunion-waffles. If
the executable exists, the tool will run it. If it doesn't exist, we would see
a CommandNotFound error.