Permalink
Browse files

Rename to yanc - Yet Another Nodester CLI

  • Loading branch information...
1 parent f91dc75 commit 70e1e74bd7b9442e21d0199c0ef52854502adfff @agnoster committed Feb 6, 2011
Showing with 70 additions and 45 deletions.
  1. +24 −24 README.md
  2. +0 −1 bin/{nodester.js → yanc.js}
  3. +27 −0 doc/commands.md
  4. +9 −9 doc/config.md
  5. +5 −6 doc/nodester.md
  6. +5 −5 package.json
  7. 0 nodester-client.js → yanc.js
View
@@ -1,31 +1,31 @@
-# nodester-client
+# yanc
-> A client for the [nodester][] platform
+> Yet Another [Nodester][nodester] Client
## WARNING: THE README IS A LIE (for now)
In the spirit of [Readme-Driven Development][RDD], this document describes the intended 0.1.0 behavior. The management bears no responsibility for divergent, or even deviant, behavior on the part of the software in the current pre-release state.
## What is this I don't even.
-[nodester][] is an open-source platform for hosting [node][] apps, and I think that's the bee's knees. However, their [API][nodester API] - while delicious and moist - is a bit cumbersome to use with only curl. So, to fill this gap, nodester-client should give you a nice command-line tool to interface with it. If you've used the [heroku CLI][], you'll know what we're going for here.
+[nodester][] is an open-source platform for hosting [node][] apps, and I think that's the bee's knees. However, their [API][nodester API] - while delicious and moist - is a bit cumbersome to use with only curl. So, to fill this gap, yanc should give you a nice command-line tool to interface with it. If you've used the [heroku CLI][], you'll know what we're going for here.
-Goals: assume only the tools you'd need anyway, namely [node][], [npm][], and [git][]. Whenever possible, nodester-client uses simple conventions to avoid tedious option-passing. See [Configuration](#Configuration) for more.
+Goals: assume only the tools you'd need anyway, namely [node][], [npm][], and [git][]. Whenever possible, yanc uses simple conventions to avoid tedious option-passing. See [Configuration](#Configuration) for more.
## Quick start
To get started quickly, install with [npm][]:
- $ npm install nodester-client
+ $ npm install yanc
If you've already registered with nodester, deploying a new app is easy:
$ cd ~/projects/pantscompetition/
- $ nodester create
+ $ yanc create
+OK app pantscompetition created, added remote nodester
- $ nodester push
+ $ yanc push
+OK pushed branch master to nodester
- $ nodester start
+ $ yanc start
+OK app pantscompetetion started
That should do it!
@@ -34,19 +34,19 @@ That should do it!
### Check [nodester] status
- $ nodester status
+ $ yanc status
+OK Nodester is up
Apps hosted: 73
Apps running: 20
### Request a coupon
- $ nodester coupon
+ $ yanc coupon
+OK Coupon will be sent to my_email@from-git-config.com
### Register a user
- $ nodester register MYCOUPONCODE
+ $ yanc register MYCOUPONCODE
# registering user with following information:
Username: fancypants
Email: fancy@pants.org
@@ -61,33 +61,33 @@ That should do it!
### Creating an app
- $ nodester create
+ $ yanc create
+OK created application pantscompetition
# added remote nodester
### Pushing app
- $ nodester push
+ $ yanc push
# pushing to remote nodester from branch master
+OK push received
### Starting/stopping app
- $ nodester start
+ $ yanc start
+OK app pantscompetition started
- $ nodester stop
+ $ yanc stop
+OK app pantscompetition stopped
### Installing/upgrading packages
- $ nodester npm install express
+ $ yanc npm install express
+OK installed package express@1.0.0 in app pantscompetition
- $ nodester npm uninstall express
+ $ yanc npm uninstall express
+OK uninstalled package express in app pantscompetition
Or, install all advertised dependencies from `package.json`
- $ nodester npm install
+ $ yanc npm install
# resolving dependencies from package.json...
+OK installed package express@1.0.3
+OK installed package socket.io@0.6.8
@@ -100,10 +100,10 @@ Or, install all advertised dependencies from `package.json`
### Keys
-nodester-client has a small set of configuration keys, and it'll try to guess sensible defaults so you don't have to type them.
+yanc has a small set of configuration keys, and it'll try to guess sensible defaults so you don't have to type them.
- **base**
- * Server where `nodester-client` expects to talk to the API service
+ * Server where `yanc` expects to talk to the API service
* Defaults to `api.nodester.com`
- **email**
* The email you want to receive a coupon to or register your user with
@@ -136,7 +136,7 @@ You can specify a value for any key by passing `--configkey="value"` on the comm
You can also use `nodester config`:
- $ nodester config
+ $ yanc config
user fancypants # source: whoami
email fancy@pants.org # source: git config user.email
key /home/fancypants/.ssh/id_rsa.pub # source: default
@@ -145,15 +145,15 @@ You can also use `nodester config`:
Setting a config variable works, too:
- $ nodester config app "pantscompetition"
+ $ yanc config app "pantscompetition"
# in a .git project, setting local configuration
app pantscompetition # source: git config nodester.app
- $ nodester config pass --prompt --global
+ $ yanc config pass --prompt --global
Password:
Confirm:
# set global configuration
pass ************** # source: git config nodester.pass
- $ nodester config user "fancy" --global
+ $ yanc config user "fancy" --global
# set global configuration
user fancy # source: git config nodester.app
@@ -4,7 +4,6 @@
var cli = require('../lib/cli.js').enable('version', 'status').disable('help')
, stdio = process.binding('stdio')
, child_process = require('child_process')
- , nodester = require('../nodester-client')
, Config = require('../lib/config.js')
, sys = require('sys')
, Nodester = require('nodester-api').nodester
View
@@ -0,0 +1,27 @@
+Usage:
+ yanc <command> [arguments] [--config=value]*
+
+Commands:
+ Core:
+ help
+ config
+ status
+
+ User:
+ coupon
+ register
+ password
+ update
+ unregister
+
+ App:
+ create
+ info
+ start
+ stop
+ restart
+ push
+ link
+ list
+ delete
+
View
@@ -1,45 +1,45 @@
-nodester-config(1) -- nodester CLI configuration
+yanc-config(1) -- yanc CLI configuration
================================================
## SYNOPSIS
-`nodester` config [<key> [<value>]]
+`yanc` config [<key> [<value>]]
## DESCRIPTION
-nodester has a powerful configuration system that's probably best
+yanc has a powerful configuration system that's probably best
left alone. However, if you cannot be dissuaded from tinkering, here's
what you should know:
* Command-line flags rule:
Any key can be overridden on the commandline. For example, the email
for a coupon request can be set on the commandline like so:
- nodester coupon --email=address@example.com
+ yanc coupon --email=address@example.com
* Environment variables:
The second place configuration variables can be set is in the environment.
For instance, `export NODESTER_ROOT=http://api2.nodester.com/` would set
the value for <root> to 'http://api2.nodester.com/' within the current shell.
* Git config:
- nodester-client stores any configuration keys in the "nodester" section of
+ yanc stores any configuration keys in the "nodester" section of
the git config. This means the same configuration rules as for git apply: local
- trumps global, which trumps system. If you use `nodester config` to set a
+ trumps global, which trumps system. If you use `yanc config` to set a
config key, it will either set it with `git config --local` (if you specify
`--local` or are in a git project), or it will set it with `git config --global`
(if you specify `--global` or are not in a git project).
* Defaults:
- Out of the box, nodester tries to pick smart defaults. In some cases, this default
+ Out of the box, yanc tries to pick smart defaults. In some cases, this default
will be frozen to the config. For instance, when a coupon is requested we save the
- email it was requested for, so that a subsequent `nodester register` will use the
+ email it was requested for, so that a subsequent `yanc register` will use the
correct email, even if git has a different email configured in the meantime.
## KEYS
* _base_:
- Server where `nodester-client` expects to talk to the API service
+ Server where `yanc` expects to talk to the API service
default: "api.nodester.com"
* <email>:
Receive a coupon or register your user to this address
View
@@ -1,21 +1,20 @@
-nodester(1) -- command-line client for nodester API
+yanc(1) -- Yet Another Nodester CLI
===================================================
## SYNOPSIS
-`nodester` <command> [args]
+`yanc` <command> [args]
## DESCRIPTION
-`nodester` is a command-line client provided by the nodester-client
-package. It speaks to the [nodester API][], and strives to use sane
+`yanc` is a command-line client that speaks to the [nodester API][], and strives to use sane
defaults for every configuration parameter. In an ideal case, you
should only have to specify config parameters if you are doing something
surprising, as long as you are using `git` and `npm` (including a
`package.json` for your app).
-The CLI itself is subdivided into separate commands. Use `nodester help [command]`
-for additional information on any one, or use `man nodester-command`.
+The CLI itself is subdivided into separate commands. Use `yanc help [command]`
+for additional information on any one, or use `man yanc-command`.
* `help` [command]:
Invoked on its own, displays this man page. You can also pass it a
View
@@ -1,11 +1,11 @@
{
- "name": "nodester-client",
- "description": "A client for the nodester platform",
+ "name": "yanc",
+ "description": "Yet Another Nodester CLI",
"version": "0.0.1",
- "homepage": "https://github.com/agnoster/nodester-client/",
- "repository": "git://github.com/agnoster/nodester-client.git",
+ "homepage": "https://github.com/agnoster/yanc/",
+ "repository": "git://github.com/agnoster/yanc.git",
"author": "Isaac Wolkerstorfer <agnoster@gmail.com> (http://agnoster.net/)",
- "main": "nodester-client",
+ "main": "yanc",
"directories": {
"lib": "./lib",
"doc": "./doc",
File renamed without changes.

0 comments on commit 70e1e74

Please sign in to comment.