Skip to content

Commit

Permalink
Updated command execution documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
webzakimbo committed Jan 20, 2023
1 parent cf6e04a commit edbb183
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/usage/executing-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ OR, to pass in parameters
Invoking commands from orchestration scripts
-------------------------------------------

An orchestration script is just a Ruby script configured to be attached, and executed in the context, of a specific Bcome node.

If you have a node instance, for example :doc:`../core-concepts/node`, then any available command may be invoked directly on it.

For example, given a node in an instance var @node, and a command, :foo, you would:
Expand All @@ -94,3 +96,11 @@ For example, given a node in an instance var @node, and a command, :foo, you wou
.. hint::

Any command, be they in-built menu commands (see :doc:`command-menu`), public-methods on a given node object, or a custom-command you've defined yourself in the Registry (see :doc:`../registry/overview`), is accessible in this way.

For more information on writing orchestration scripts see :doc:`../orchestration/external-ruby-scripting` and :doc:`../orchestration/internal-ruby-scripting`.

For information on how to integrate custom scripts into your installation, see :doc:`../registry/overview`




0 comments on commit edbb183

Please sign in to comment.