rlx-alias(3) -- alias commands
==============================

## SYNOPSIS

Commands for modifying aliases used to define servers, databases and usernames.

Aliases provide a convenient way to reference frequently used servers (and databases).

Alias names are simple identifiers containing only alphanumeric characters and hyphens.

### References

An alias reference is the alias name prefixed with an @ symbol. For example, if you created an alias using the name *local* it is referenced as `@local`.

The `alias` commands accept implicit and explicit alias references (with or without the @ character), all other commands require an explicit reference. You must use an explicit reference (with the @ character) when specifiying an alias reference to other commands.

Commands that support alias references are:

* `cd`
* `docs`
* `login`
* `logout`
* `repl`
* `restart`
* `session`
* `stats`
* `tasks`
* `version`
* `whoami`

## COMMANDS

* `alias`:

List aliases.

* `alias [name]`:

Print alias information for *name*.

* `alias [name] [server] [database] [username]`:

Save an alias identified by *name*. The *server* when specified must begin with either the *http* or *https* scheme. The *database* and *username* options are not required.

If the named alias exists you will be prompted to confirm overwriting the alias file.

* `alias rm [name] [force]`:

Delete an alias. If the named alias exist you will be prompted to confirm deletion  unless the *force* option is `true`.

* `alias server [name] [server]`:

Set the *server* field for an existing alias, if the alias does not exist an error is printed.

* `alias db [name] [database]`:

Set the *database* field for an existing alias, if the alias does not exist an error is printed.

* `alias user [name] [username]`:

Set the *username* field for an existing alias, if the alias does not exist an error is printed.

* `alias url [name] [include]`:

Print the URL for an alias, if *include* is `true` the database name is included in the URL. When a database name is included it is *not* URL encoded so may display multiple path elements if the database name includes the / character.

## BUGS

**rlx** is written in bash and depends upon `bash >= 4.2`.

## COPYRIGHT

**rlx** is copyright (c) 2013 muji <http://xpm.io>

## SEE ALSO

rlx(1), couchdb(3)