github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/builtins/core/modules/murex-package_doc.yaml (about)

     1  - DocumentID: murex-package
     2    Title: >+
     3      `murex-package`
     4    CategoryID: commands
     5    Summary: >-
     6      Murex's package manager
     7    Description: |-
     8      {{ include "gen/includes/package-modules.inc.md" }}
     9    Usage: |-
    10      Install a new package
    11  
    12      ```
    13      murex-package install uri -> <stdout>
    14      ```
    15  
    16      Remove an existing package
    17  
    18      ```
    19      murex-package remove package -> <stdout>
    20      ```
    21  
    22      Update all packages
    23  
    24      ```
    25      murex-package update -> <stdout>
    26      ```
    27  
    28      Enable a package or module which had been disabled
    29  
    30      ```
    31      murex-package enable package
    32  
    33      murex-package enable package/module
    34      ```
    35  
    36      Disable a package
    37  
    38      ```
    39      murex-package disable package
    40  
    41      murex-package disable package/module
    42      ```
    43  
    44      Import packages from another package database
    45  
    46      ```
    47      murex-package import [ uri/ | local/path/ ]packages.json -> <stdout>
    48      ```
    49  
    50      Check status of murex packages
    51  
    52      ```
    53      murex-package status -> <stdout>
    54      ```
    55    Examples:
    56    Flags:
    57      install: |-
    58        Installs a package from a user defined URI
    59      remove: |-
    60        Removes an installed package from disk
    61      update: |-
    62        Updates all installed packages
    63      enable: |-
    64        Enables a previously disabled package or module
    65      disable: |-
    66        Disables a previously enabled package or module
    67      import: |-
    68        Import packages described in a backup package DB from user defined URI or local path
    69      status: |-
    70        Returns the version status of locally installed packages
    71      list: |-
    72        Returns a list of indexed packages/modules (eg what's enabled or disabled)
    73      new: |-
    74        A wizard to help with creating a new package
    75      cd: |-
    76        Changes working directory to a package's install location
    77      git: |-
    78        Runs `git` against a package
    79      reload: |-
    80        Reloads all enabled modules
    81    Detail: |-
    82      ### `murex-package list`... `enabled` vs `loaded`
    83  
    84      `enabled` and `disabled` reads the package status from disk rather than the
    85      package cache in your current Murex session (like `runtime` reports). This
    86      because the typical use for `murex-package list enabled|disabled` is to view
    87      which packages and modules will be loaded with any new murex session.
    88      
    89      If you wish to view what modules are loaded in a current session then use
    90      `murex-package list loaded` instead. This is also equivalent to using
    91      `runtime --modules`.
    92    Synonyms:
    93    Related:
    94    - runtime
    95    - config
    96    - murex-docs
    97    - function
    98    - private
    99    - alias
   100    - profile
   101    - modules