github.com/omnigres/cli@v0.1.4/docs/modules/ROOT/pages/index.adoc (about)

     1  = Omnigres CLI
     2  :experimental: true
     3  
     4  Omnigres comes with command-line tooling to make development, debugging and deployment experiences seamless.
     5  
     6  == Prerequisites
     7  
     8  |===
     9  | Dependency | Description
    10  
    11  | **Docker**
    12  | Required to operate local instances
    13  |===
    14  
    15  == Quick start
    16  
    17  You can grab the latest pre-bullt release of CLI on https://github.com/omnigres/cli/releases[GitHub] and install the `omnigres` binary in your `PATH`
    18  
    19  === Initializing a project
    20  
    21  Create a directory for your new project and use `omnigres init`:
    22  
    23  [,console]
    24  ----
    25  $ mkdir project
    26  $ cd project
    27  $ omnigres init
    28  ----
    29  
    30  It will create `omnigres.yaml` and _directory_name/src_ directory for the project.
    31  
    32  [TIP]
    33  ====
    34  If you want to specify a directory instead, you can use the `-w` flag:
    35  
    36  [,console]
    37  ----
    38  $ omigres init
    39  ----
    40  ====
    41  
    42  === Running interactively
    43  
    44  In the same directory, use `omnigres to run the project` in foreground:
    45  
    46  [,console]
    47  ----
    48  $ omnigres run
    49  ----
    50  
    51  At the end of the startup sequence, it will print a table with
    52  all endpoint URLs for all the xref:glossary.adoc#orb-term[orbs].
    53  
    54  You can terminate it by pressing kbd:[Ctrl-C]. After termination, its data volume will become unavailable.
    55  
    56  
    57  === Running in the background
    58  
    59  To run it in the **background**, use `omnigres start`:
    60  
    61  [,console]
    62  ----
    63  $ omnigres start
    64  ----
    65  
    66  This will create `omnigres.run.yaml` file to track the container it's going to be running in.
    67  
    68  You can get the endpoint URLs using `omnigres endpoints`
    69  
    70  [,console]
    71  ----
    72  $ omnigres endpoints
    73  ----
    74  
    75  To terminate it, run `omnigres stop`:
    76  
    77  [,console]
    78  ----
    79  $ omnigres stop
    80  ----
    81  
    82  You can restart it again by using `omnigres start`. It will
    83  retain the data volume.