Skip to content

Commit

Permalink
Fix meteor#5416 Include meteor shell reference in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oricordeau committed Dec 13, 2015
1 parent 77b628d commit 3dd1d0b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/client/full-api/commandline.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,27 @@ <h3 id="meteoradmin">meteor admin</h3>
helpful functions for managing a Meteor release. Run `meteor help admin` for
more information.

<h3 id="meteorshell">meteor shell</h3>

When `meteor shell` is executed in an application directory where a server
is already running, it connects to the server and starts an interactive
shell for evaluating server-side code.

Multiple shells can be attached to the same server. If no server is
currently available, `meteor shell` will keep trying to connect until it
succeeds.

Exiting the shell does not terminate the server. If the server restarts
because a change was made in server code, or a fatal exception was
encountered, the shell will restart along with the server. This behavior
can be simulated by typing `.reload` in the shell.

The shell supports tab completion for global variables like `Meteor`,
`Mongo`, and `Package`. Try typing `Meteor.is` and then pressing tab.

The shell maintains a persistent history across sessions. Previously-run
commands can be accessed by pressing the up arrow.


{{/markdown}}
</div>
Expand Down
3 changes: 2 additions & 1 deletion docs/client/full-api/tableOfContents.js
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,8 @@ var toc = [
"meteor publish-for-arch",
"meteor publish-release",
"meteor test-packages",
"meteor admin"
"meteor admin",
"meteor shell"
] ]
];

Expand Down

0 comments on commit 3dd1d0b

Please sign in to comment.