github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/commands/murex-package.md (about)

     1  # `murex-package`
     2  
     3  > Murex's package manager
     4  
     5  ## Description
     6  
     7  Murex comes with it's own package manager to make managing plugins easier.
     8  
     9  The format of the packages is a directory, typically located at `~/.murex_modules`,
    10  which contains one or more murex scripts. Each script can be it's own module.
    11  ie there are multiple modules that can be grouped together and distributed as a
    12  single package.
    13  
    14  The way packages and modules are represented is as a path:
    15      package/module
    16  
    17  `murex-package` is a package management tool for administrating murex modules
    18  and packages.
    19  
    20  | Name                                                         | Summary                                                      |
    21  | ------------------------------------------------------------ | ------------------------------------------------------------ |
    22  | https://github.com/lmorg/murex-module-jump                   | Enables autojump functionalities                             |
    23  | https://github.com/orefalo/murex-module-starship             | starship - The minimal, blazing-fast, and infinitely customizable prompt |
    24  | and [many more](https://github.com/search?q=murex-module-&type=repositories) | Murex modules typically follow the `murex-module-*` naming convention |
    25  
    26  ## Usage
    27  
    28  Install a new package
    29  
    30  ```
    31  murex-package install uri -> <stdout>
    32  ```
    33  
    34  Remove an existing package
    35  
    36  ```
    37  murex-package remove package -> <stdout>
    38  ```
    39  
    40  Update all packages
    41  
    42  ```
    43  murex-package update -> <stdout>
    44  ```
    45  
    46  Enable a package or module which had been disabled
    47  
    48  ```
    49  murex-package enable package
    50  
    51  murex-package enable package/module
    52  ```
    53  
    54  Disable a package
    55  
    56  ```
    57  murex-package disable package
    58  
    59  murex-package disable package/module
    60  ```
    61  
    62  Import packages from another package database
    63  
    64  ```
    65  murex-package import [ uri/ | local/path/ ]packages.json -> <stdout>
    66  ```
    67  
    68  Check status of murex packages
    69  
    70  ```
    71  murex-package status -> <stdout>
    72  ```
    73  
    74  ## Flags
    75  
    76  * `cd`
    77      Changes working directory to a package's install location
    78  * `disable`
    79      Disables a previously enabled package or module
    80  * `enable`
    81      Enables a previously disabled package or module
    82  * `git`
    83      Runs `git` against a package
    84  * `import`
    85      Import packages described in a backup package DB from user defined URI or local path
    86  * `install`
    87      Installs a package from a user defined URI
    88  * `list`
    89      Returns a list of indexed packages/modules (eg what's enabled or disabled)
    90  * `new`
    91      A wizard to help with creating a new package
    92  * `reload`
    93      Reloads all enabled modules
    94  * `remove`
    95      Removes an installed package from disk
    96  * `status`
    97      Returns the version status of locally installed packages
    98  * `update`
    99      Updates all installed packages
   100  
   101  ## Detail
   102  
   103  ### `murex-package list`... `enabled` vs `loaded`
   104  
   105  `enabled` and `disabled` reads the package status from disk rather than the
   106  package cache in your current Murex session (like `runtime` reports). This
   107  because the typical use for `murex-package list enabled|disabled` is to view
   108  which packages and modules will be loaded with any new murex session.
   109  
   110  If you wish to view what modules are loaded in a current session then use
   111  `murex-package list loaded` instead. This is also equivalent to using
   112  `runtime --modules`.
   113  
   114  ## See Also
   115  
   116  * [Modules and Packages](../user-guide/modules.md):
   117    An introduction to Murex modules and packages
   118  * [Profile Files](../user-guide/profile.md):
   119    A breakdown of the different files loaded on start up
   120  * [`alias`](../commands/alias.md):
   121    Create an alias for a command
   122  * [`config`](../commands/config.md):
   123    Query or define Murex runtime settings
   124  * [`function`](../commands/function.md):
   125    Define a function block
   126  * [`murex-docs`](../commands/murex-docs.md):
   127    Displays the man pages for Murex builtins
   128  * [`private`](../commands/private.md):
   129    Define a private function block
   130  * [`runtime`](../commands/runtime.md):
   131    Returns runtime information on the internal state of Murex
   132  
   133  <hr/>
   134  
   135  This document was generated from [builtins/core/modules/murex-package_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/modules/murex-package_doc.yaml).