mirrors/nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus synced 2026-07-28 19:12:46 +00:00
Code Issues Releases Wiki Activity

Reorganize install instructions across multiple help files

Browse Source 
I've also improved the install instructions based on what actually works when
deploying the GitHub-hosted version of the codebase to App Engine using an
external cloud account.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=135390967
This commit is contained in:
mcilwain
2016-10-07 15:29:47 -04:00
committed by Ben McIlwain
parent 940fadff8a
commit 30adfd28fc
5 changed files with 340 additions and 254 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin-tool.md
+26 -11
View File
@@ -6,27 +6,42 @@ number of things in a running domain registry environment, including creating
registrars, updating premium and reserved lists, running an EPP command from a
given XML file, and performing various backend tasks like re-running RDE if the
most recent export failed. Its code lives inside the tools package
(`java/google/registry/tools`), and is compiled by building the `nomulus`
target in the Bazel BUILD file in that package.
(`java/google/registry/tools`), and is compiled by building the `nomulus` target
in the Bazel BUILD file in that package.
To build the tool and display its command-line help, execute this command:
[TOC]
$ bazel run //java/google/registry/tools:nomulus -- --help
## Build the tool
For future invocations you should alias the compiled binary in the
`bazel-genfiles/java/google/registry` directory or add it to your path so that
you can run it more easily. The rest of this guide assumes that it has been
To build the `nomulus` tool, execute the following `bazel build` command inside
any directory of the codebase. You must rebuild the tool any time that you edit
configuration or make database schema changes.
```shell
$ bazel build //java/google/registry/tools:nomulus
```
It's recommended that you alias the compiled binary located at
`bazel-genfiles/java/google/registry/nomulus` (or add it to your shell path) so
that you can run it easily. The rest of this guide assumes that it has been
aliased to `nomulus`.
## Running the tool
The registry tool is always called with a specific environment to run in using
the -e parameter. This looks like:
$ nomulus -e production {command name} {command parameters}
```shell
$ nomulus -e production {command name} {command parameters}
```
To see a list of all available commands along with usage information, run
nomulus without specifying a command name, e.g.:
You can get help about the tool in general, or about a specific subcommand, as
follows:
$ nomulus -e alpha
```shell
$ nomulus -e alpha --help # Lists all subcommands
$ nomulus -e alpha SUBCOMMAND --help # Help for a specific subcommand
```
Note that the documentation for the commands comes from JCommander, which parses
metadata contained within the code to yield documentation.