Skip to content

Commit

Permalink
Hide the start-session command (#984)
Browse files Browse the repository at this point in the history
Until it's ready. See #983
  • Loading branch information
adamchalmers authored Oct 22, 2024
1 parent c785529 commit dd4fbdb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/cmd_start_session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@ use std::net::SocketAddr;
use anyhow::Result;
use clap::Parser;

/// Starts a modeling session
/// Starts a modeling session.
///
/// This command starts a server on localhost (on the configurable interface), and
/// waits to receive KCL programs over that server. It also connects to the KittyCAD
/// API and keeps the connection alive until this process is stopped. When it receives
/// a KCL program over the local server, it executes it using the long-lived KittyCAD
/// connection.
///
/// This subcommand is designed to be used with `zoo kcl snapshot --session localhost:3333`,
/// which will reuse the existing connection started by `zoo start-session localhost:3333`.
#[derive(Parser, Debug, Clone)]
#[clap(verbatim_doc_comment)]
pub struct CmdStartSession {
Expand Down
2 changes: 2 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ enum SubCommand {
Kcl(cmd_kcl::CmdKcl),
Ml(cmd_ml::CmdMl),
Say(cmd_say::CmdSay),
// Hide until <https://github.com/KittyCAD/cli/issues/983> is done.
#[clap(hide = true)]
StartSession(cmd_start_session::CmdStartSession),
Open(cmd_open::CmdOpen),
Update(cmd_update::CmdUpdate),
Expand Down

0 comments on commit dd4fbdb

Please sign in to comment.