This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new f3c7c7fa2d Refresh the Console plugin usage transcript in the
reference docs
f3c7c7fa2d is described below
commit f3c7c7fa2dadc781cbe49bb7312c577f109e0b8a
Author: Stephen Mallette <[email protected]>
AuthorDate: Mon Sep 14 12:41:31 2026 +0000
Refresh the Console plugin usage transcript in the reference docs
The "Dependencies and Plugin Usage" example in the Gremlin Console
reference no longer matched the Console's behavior. The :plugin list
output omitted the tinkerpop.credentials plugin and showed
tinkerpop.sugar as inactive, even though the plugins bundled with the
standard Console distribution are all active by default. The :install
walkthrough also implied that hadoop-gremlin becomes usable as soon as
it is installed.
Update the transcript to list the current default plugins, demonstrate
deactivating and reactivating a plugin with :plugin unuse and :plugin
use, and show that installing a dependency such as hadoop-gremlin
reports that the Console must be restarted before the plugin can be
used.
Assisted-by: Kiro:claude-opus-4.8
---
docs/src/reference/gremlin-applications.asciidoc | 40 +++++++++++-------------
1 file changed, 18 insertions(+), 22 deletions(-)
diff --git a/docs/src/reference/gremlin-applications.asciidoc
b/docs/src/reference/gremlin-applications.asciidoc
index 7b3ba2ec00..d89d07f4ec 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -228,36 +228,32 @@ The following Gremlin Console session demonstrates the
basics of these features:
gremlin> :plugin list <1>
==>tinkerpop.remote[active]
==>tinkerpop.utilities[active]
-==>tinkerpop.sugar
-==>tinkerpop.tinkergraph[active]
-gremlin> :plugin use tinkerpop.sugar <2>
-==>tinkerpop.sugar activated
-gremlin> :install org.apache.tinkerpop hadoop-gremlin x.y.z <3>
-==>loaded: [org.apache.tinkerpop, hadoop-gremlin, x.y.z]
-gremlin> :plugin list <4>
-==>tinkerpop.remote[active]
-==>tinkerpop.utilities[active]
==>tinkerpop.sugar[active]
+==>tinkerpop.credentials[active]
==>tinkerpop.tinkergraph[active]
-==>tinkerpop.hadoop
-gremlin> :plugin use tinkerpop.hadoop <5>
-==>tinkerpop.hadoop activated
-gremlin> :plugin list <6>
+gremlin> :plugin unuse tinkerpop.sugar <2>
+==>tinkerpop.sugar deactivated - restart your console for this to take effect
+gremlin> :plugin list <3>
==>tinkerpop.remote[active]
-==>tinkerpop.sugar[active]
==>tinkerpop.utilities[active]
-==>tinkerpop.hadoop[active]
+==>tinkerpop.sugar
+==>tinkerpop.credentials[active]
==>tinkerpop.tinkergraph[active]
+gremlin> :plugin use tinkerpop.sugar <4>
+==>tinkerpop.sugar activated
+gremlin> :install org.apache.tinkerpop hadoop-gremlin x.y.z <5>
+==>Loaded: [org.apache.tinkerpop, hadoop-gremlin, x.y.z] - restart the console
to use [tinkerpop.hadoop]
----
<1> Show a list of "available" plugins. The list of "available" plugins is
determined by the classes available on
-the Console classpath. Plugins need to be "active" for their features to be
available.
-<2> To make a plugin "active" execute the `:plugin use` command and specify
the name of the plugin to enable.
-<3> Sometimes there are external dependencies that would be useful within the
Console. To bring those in, execute
-`:install` and specify the Maven coordinates for the dependency.
-<4> Note that there is a "tinkerpop.hadoop" plugin available, but it is not
yet "active".
-<5> Again, to use the "tinkerpop.hadoop" plugin, it must be made "active" with
`:plugin use`.
-<6> Now when the plugin list is displayed, the "tinkerpop.hadoop" plugin is
displayed as "active".
+the Console classpath. A plugin marked `[active]` has its features exposed to
the Console. The plugins bundled with
+the standard Console distribution are all "active" by default.
+<2> A plugin's features can be withdrawn by deactivating it with the `:plugin
unuse` command.
+<3> Once deactivated, the plugin is no longer marked as "active" in the plugin
list.
+<4> A deactivated plugin is enabled again with the `:plugin use` command,
which takes the name of the plugin to activate.
+<5> External dependencies that would be useful within the Console are brought
in with the `:install` command, which
+takes the Maven coordinates of the dependency. Any Gremlin plugins that the
dependency provides then become available.
+Some plugins, such as `hadoop-gremlin`, require the Console to be restarted
before they can be used.
WARNING: Plugins must be compatible with the version of the Gremlin Console
(or Gremlin Server) being used. Attempts
to use incompatible versions cannot be guaranteed to work. Moreover, be
prepared for dependency conflicts in
