XIBLE Package Manager, for interacting with the XIBLE registry.
Parameters
All commands mentioned on this page have the following parameters available to them;
name | description |
---|---|
--config | The XIBLE configuration file to use. Defaults to ~./xible/config.json . The file is automatically created with defaults by XIBLE if it does not exist yet. |
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
Synopsis
xiblepm <context> <command>
[--config=<config>]
xiblepm flow install <name>
Installs a flow by the given name.
If a flow with the name or alt-name already exists, the operation will be canceled unless --force
is provided.
Prerequisites
- The given name must exist as a flow in the XIBLE registry.
- The specified publish user must exist as a user in the XIBLE registry.
- The configuration setting
registry.flows.allowinstall
must be set to true. - The configuration setting
registry.url
must point to a valid URL.
Parameters
name | description |
---|---|
name | The name of the flow in the XIBLE registry. |
--publish-user-name | The name of user who published the flow. Required. |
--alt-name | The name of the installed flow after installation. If not provided, the flow will be installed with the name as stored in the registry. |
--force | Overwrite an existing flow. |
Changes
version | availability |
---|---|
>= 0.5.0 | General availability. |
>= 0.25.0 | Flows are now stored by user. As a result, the newly added --publish-user-name parameter is required. |
Synopsis
xiblepm flow install
<name>
[--publish-user-name=<user-name>]
[--alt-name=<alt-name>]
[--force]
xiblepm flow publish <name>
Publishes the installed flow by the given name. Any existing flow with the same name or altname will be overwritten.
Prerequisites
- The given flow name must exist as a flow in the XIBLE installation.
- You need to be logged on to the XIBLE registry.
- If a flow by the given name or altname already exists in the registry, then you must be logged on with the same user as the original publish user of the package in order to overwrite.
- The configuration setting
registry.flows.allowpublish
must be set to true. - The configuration setting
registry.url
must point to a valid URL.
Parameters
name | description |
---|---|
name | The name of the flow in the XIBLE registry. |
--altname | The name of the flow as it is published. If not provided, the flow will be published with the original flow name. |
Changes
version | availability |
---|---|
>= 0.5.0 | General availability. |
Synopsis
xiblepm flow publish
<name>
[--altname=<altname>]
xiblepm flow delete <name>
Deletes the flow from the registry by the given name, for the current user.
Prerequisites
- You need to be logged on to the XIBLE registry.
- The given flow name must exist as a flow in the registry for the user which is logged in.
Parameters
name | description |
---|---|
name | The name of the published flow on the registry. |
Changes
version | availability |
---|---|
>= 0.26.0 | General availability. |
Synopsis
xiblepm flow delete
<name>
xiblepm flow search <text>
Search the registry for flows by the given text. Returns a list of found flows, including their publisher.
Note that a full-text-search is performed. As a result, partial search queries may not yield desired results.
Prerequisites
- The configuration setting
registry.url
must point to a valid URL.
Parameters
name | description |
---|---|
text | The text to search for in the registry. |
Changes
version | availability |
---|---|
>= 0.5.0 | General availability. |
>= 0.25.0 | Added publish user to result list. |
Synopsis
xiblepm flow search
<text>
xiblepm nodepack init <node-name>
Generates a default node structure within the nodepack, using the given node-name
.
Prerequisites
- A
package.json
must be present, which must contain the nodepack name in thename
field. - A node structure must not be present in the current working directory (
structure.json
,typedef.json
,index.js
may not exist). - A directory with the same name as
node-name
may not exist in the current working directory.
Parameters
name | description |
---|---|
node-name | The name of the node to generate the structure for. |
Changes
version | availability |
---|---|
>= 0.15.0 | General availability. |
Synopsis
xiblepm nodepack init
<node-name>
xiblepm nodepack install <name>
Installs a nodepack by the given name.
Note that if you install a nodepack which contains nodes with the same name as previously installed nodepacks, only the last loaded duplicate nodes will be available in XIBLE.
Prerequisites
- The given name must exist as a nodepack in the XIBLE registry.
- The configuration setting
registry.nodepacks.allowinstall
must be set to true. - The configuration setting
registry.url
must point to a valid URL.
Parameters
name | description |
---|---|
name | The name of the nodepack in the XIBLE registry. |
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
>= 0.4.1 | Available on Windows. (#14) |
Synopsis
xiblepm nodepack install
<name>
xiblepm nodepack publish
Publishes the nodepack/package from your current working directory to the XIBLE registry. Only the package.json is pushed, all other information is fetched by the XIBLE registry from NPM. Therefore you must first publish your package with NPM before publishing to XIBLE.
If the package was previously published to the XIBLE registry, this action will trigger a refresh of the NPM registry.
Prerequisites
- A valid package.json file must be present in the current working directory.
- There must be at least one structure.json in the current working directory or one of its subdirectories.
- Your package.json needs to be published to NPM.
- Nodes must adhere to the naming conventions.
- You need to be logged on to the XIBLE registry.
- If this concerns a refresh, you must be logged on with the same user as the original publish user of the package.
- The configuration setting
registry.nodepacks.allowpublish
must be set to true. - The configuration setting
registry.url
must point to a valid URL.
Changes
version | availability |
---|---|
>= 0.1.0 | General availability. |
>= 0.8.0 | Stricter validation on node names. |
>= 0.16.0 | The published version number is displayed after completion. (#44) |
Synopsis
xiblepm nodepack publish
xiblepm nodepack remove <name>
Removes a nodepack by the given name.
Parameters
name | description |
---|---|
name | The name of the nodepack as it is installed. |
Changes
version | availability |
---|---|
>= 0.9.0 | General availability. |
Synopsis
xiblepm nodepack remove
<name>
xiblepm nodepack search <text>
Search the registry for nodepacks by the given text.
Note that a full-text-search is performed. As a result, partial search queries may not yield desired results.
Prerequisites
- The configuration setting
registry.url
must point to a valid URL.
Parameters
name | description |
---|---|
text | The text to search for in the registry. |
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
Synopsis
xiblepm nodepack search
<text>
xiblepm nodepack upgrade <name>
Upgrades the installed nodepack by removing and reinstalling it. If the nodepack is not installed yet, than it will be installed. If no "name" is provided, all installed nodepacks will be upgraded.
Prerequisites
- If a nodepack name is provided, that name must exist as a nodepack in the XIBLE registry.
- The configuration setting
registry.nodepacks.allowinstall
must be set to true. - The configuration setting
registry.url
must point to a valid URL.
Changes
version | availability |
---|---|
>= 0.9.0 | General availability. |
>= 0.13.0 | Not providing a specific nodepack name to this command upgrades all installed nodepacks. (#42) |
Synopsis
xiblepm nodepack upgrade
<name>
xiblepm user add
Adds a new user to the registry, after providing related information. These will be asked for after running the command, they are not command line parameters.
Prerequisites
- The configuration setting
registry.url
must point to a valid URL.
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
Synopsis
xiblepm user add
xiblepm user login
Logs you into the registry, after providing a username and password. These will be asked for after running the command, they are not command line parameters.
Prerequisites
- The configuration setting
registry.url
must point to a valid URL.
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
Synopsis
xiblepm user login
xiblepm user logout
Logs-out the user from the registry.
Prerequisites
- The configuration setting
registry.url
must point to a valid URL.
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
Synopsis
xiblepm user logout
xiblepm user me
Prints the name of the user logged on to the registry.
Prerequisites
- The configuration setting
registry.url
must point to a valid URL.
Changes
version | availability |
---|---|
>= 0.0.2 | General availability. |
Synopsis
xiblepm user me
xiblepm user whoami
Same as xiblepm user me.