github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/ui.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: ui'
     4  description: |
     5    The ui command is used to open the Nomad Web UI.
     6  ---
     7  
     8  # Command: ui
     9  
    10  The `ui` command is used to open the Nomad Web UI.
    11  
    12  ## Usage
    13  
    14  ```plaintext
    15  nomad ui [options] <identifier>
    16  ```
    17  
    18  The `ui` command can be called with no arguments, in which case the UI homepage
    19  will be opened in the default browser.
    20  
    21  An identifier may be provided, in which case the UI will be opened to view the
    22  details for that object. Supported identifiers are jobs, allocations and nodes.
    23  
    24  If ACLs are enabled, the web UI will start in an unauthenticated state and you
    25  may see a 403 Unauthorized page if anonymous read access is denied. The `nomad ui -authenticate` option will exchange your command line client's Nomad ACL
    26  token for a one-time token, which is passed to the web UI. That one-time token
    27  will be exchanged for your Nomad ACL token and stored in the browser's local
    28  storage for authentication.
    29  
    30  ## General Options
    31  
    32  @include 'general_options.mdx'
    33  
    34  ## UI Options
    35  
    36  - `-authenticate`: Exchange your Nomad ACL token for a one-time token in the
    37    web UI.
    38  
    39  - `-show-url`: Show the Nomad UI URL instead of opening with the default browser.
    40  
    41  ## Examples
    42  
    43  Open the UI homepage:
    44  
    45  ```shell-session
    46  $ nomad ui
    47  Opening URL "http://127.0.0.1:4646"
    48  ```
    49  
    50  Open the UI directly to look at a job:
    51  
    52  ```shell-session
    53  $ nomad ui redis-job
    54  http://127.0.0.1:4646/ui/jobs/redis-job
    55  ```
    56  
    57  Open the UI directly to look at an allocation:
    58  
    59  ```shell-session
    60  $ nomad ui d4005969
    61  Opening URL "http://127.0.0.1:4646/ui/allocations/d4005969-b16f-10eb-4fe1-a5374986083d"
    62  ```
    63  
    64  Open the UI and authenticate using your ACL token:
    65  
    66  ```shell-session
    67  $ NOMAD_ACL_TOKEN=e9674b26-763b-4637-a28f-0df95c53cdda nomad ui -authenticate
    68  Opening URL "http://127.0.0.1:4646" with token
    69  ```
    70  
    71  Show the UI URL without opening the browser:
    72  
    73  ```shell-session
    74  $ nomad ui -show-url
    75  URL for web UI: http://127.0.0.1:4646
    76  ```