use crate::commands;
use crate::outcome::Outcome;
use crate::output::{ColorChoice, Ctx, ErrorMessage, MessageFormat, Shell, StdCtx};
use clap::{ArgAction, Parser, Subcommand, builder::BoolishValueParser};
use std::io::Write;
use std::process::ExitCode;
use tracing::debug;
const LONG_ABOUT: &str = "\
CLI for building with Turnkey Verifiable Cloud.
Some commands accept multiple configuration input types.
Configuration values are resolved in this order, highest priority first:
1. Command-line flag (e.g. --app-id)
2. Environment variable (e.g. TVC_APP_ID)
3. Config file value (--config-file)
4. Built-in default
Special rules (exceptions to the order above):
--pivot-args replaces the config file's list entirely (does not append)
Debug-mode flags (--dangerous-deploy-debug-mode and
--dangerous-enable-debug-mode-deployments) are opt-in only: the flag
or its env var can turn debug mode ON, but its absence never turns OFF
a config file that enables it. To disable debug mode, set it false in
the config file (or omit it) and do not pass the flag.
Authentication:
Local: run `tvc login` once; commands then read ~/.config/turnkey/.
CI: set TVC_ORG_ID, TVC_API_KEY_PUBLIC, and TVC_API_KEY_PRIVATE
to authenticate without files. Env vars take precedence over local
config files. Setting some but not all three required vars will error.
Interactive behavior:
By default, commands may prompt when stdin is a TTY. Use --non-interactive
or set TVC_NON_INTERACTIVE=true to disable prompts and fail fast instead.
Output format:
--message-format human (default) prints human-readable text. Use
--message-format json to emit machine-readable output instead: one JSON
object per line (newline-delimited JSON), each with a \"reason\" field
identifying the message, including errors. JSON mode implies
--non-interactive, so commands never prompt and fail fast on missing input.";
#[derive(Debug, Parser)]
#[command(about = "CLI for building with Turnkey Verifiable Cloud", long_about = LONG_ABOUT)]
pub struct Cli {
#[arg(
long,
global = true,
env = "TVC_NON_INTERACTIVE",
action = ArgAction::SetTrue,
value_parser = BoolishValueParser::new()
)]
non_interactive: bool,
#[arg(long, global = true, value_enum, default_value_t = MessageFormat::Human)]
message_format: MessageFormat,
#[arg(long, global = true, value_enum, default_value_t = ColorChoice::Auto)]
color: ColorChoice,
#[command(subcommand)]
command: Commands,
}
impl Cli {
pub async fn run() -> ExitCode {
let args = Cli::parse();
debug!(
command = args.command.name(),
non_interactive = args.non_interactive,
message_format = ?args.message_format,
color = ?args.color,
"dispatching"
);
let shell = Shell::standard(args.message_format, args.color);
let mut ctx = Ctx::new(shell, args.non_interactive);
let result = args.command.run(&mut ctx).await;
match result {
Ok(outcome) => {
if let Err(emit_error) = ctx.shell().emit(&outcome) {
let mut stderr = std::io::stderr();
let _ = writeln!(stderr, "warning: failed to write CLI output: {emit_error}");
}
ExitCode::SUCCESS
}
Err(error) => {
let shell = ctx.shell();
let emit_result = if shell.message_format().is_json() {
shell.emit(&ErrorMessage::from_error(&error))
} else {
shell.human().error(&error)
};
if let Err(emit_error) = emit_result {
let mut stderr = std::io::stderr();
let _ = writeln!(stderr, "error: failed to write CLI error: {emit_error}");
}
ExitCode::FAILURE
}
}
}
}
impl Commands {
async fn run(self, ctx: &mut StdCtx) -> anyhow::Result<Outcome> {
match self {
Commands::Deploy { command } => match command {
DeployCommands::Approve(args) => commands::deploy::approve::run(ctx, args).await,
DeployCommands::GetStatus(args) => {
commands::deploy::get_status::run(ctx, args).await
}
DeployCommands::ProvisioningDetails(args) => {
commands::deploy::provisioning_details::run(ctx, args).await
}
DeployCommands::PostShare(args) => {
commands::deploy::post_share::run(ctx, args).await
}
DeployCommands::Status(args) => commands::deploy::status::run(ctx, args).await,
DeployCommands::Create(args) => commands::deploy::create::run(ctx, args).await,
DeployCommands::Init(args) => commands::deploy::init::run(ctx, args).await,
DeployCommands::DebugLogs(args) => {
commands::deploy::debug_logs::run(ctx, args).await
}
DeployCommands::Delete(args) => commands::deploy::delete::run(ctx, args).await,
DeployCommands::Restore(args) => commands::deploy::restore::run(ctx, args).await,
},
Commands::App { command } => match command {
AppCommands::Status(args) => commands::app::status::run(ctx, args).await,
AppCommands::List(args) => commands::app::list::run(ctx, args).await,
AppCommands::Create(args) => commands::app::create::run(ctx, args).await,
AppCommands::Init(args) => commands::app::init::run(ctx, args).await,
AppCommands::SetLiveDeploy(args) => {
commands::app::set_live_deploy::run(ctx, args).await
}
AppCommands::Delete(args) => commands::app::delete::run(ctx, args).await,
},
Commands::Keys { command } => match command {
KeysCommands::CreateQuorumKey(args) => {
commands::keys::create_quorum_key::run(ctx, args).await
}
KeysCommands::GenerateLocalQuorumKey(args) => {
commands::keys::generate_local_quorum_key::run(ctx, args).await
}
KeysCommands::InitLocalQuorumKey(args) => {
commands::keys::init_local_quorum_key::run(ctx, args).await
}
KeysCommands::ReEncryptLocalShare(args) => {
commands::keys::re_encrypt_local_share::run(ctx, args).await
}
},
Commands::Login(args) => commands::login::run(ctx, args).await,
Commands::Profile { command } => match command {
ProfileCommands::Delete(delete_args) => {
commands::login::run_delete(ctx, delete_args).await
}
},
}
}
}
#[derive(Debug, Subcommand)]
enum Commands {
Login(commands::login::Args),
Profile {
#[command(subcommand)]
command: ProfileCommands,
},
Deploy {
#[command(subcommand)]
command: DeployCommands,
},
App {
#[command(subcommand)]
command: AppCommands,
},
Keys {
#[command(subcommand)]
command: KeysCommands,
},
}
impl Commands {
fn name(&self) -> &'static str {
match self {
Commands::Login(_) => "login",
Commands::Profile { command } => match command {
ProfileCommands::Delete(_) => "profile delete",
},
Commands::Deploy { command } => command.name(),
Commands::App { command } => command.name(),
Commands::Keys { command } => command.name(),
}
}
}
#[derive(Debug, Subcommand)]
enum ProfileCommands {
Delete(commands::login::DeleteArgs),
}
#[derive(Debug, Subcommand)]
enum DeployCommands {
Approve(commands::deploy::approve::Args),
GetStatus(commands::deploy::get_status::Args),
ProvisioningDetails(commands::deploy::provisioning_details::Args),
PostShare(commands::deploy::post_share::Args),
Status(commands::deploy::status::Args),
#[command(
long_about = commands::deploy::create::LONG_ABOUT,
after_help = commands::deploy::PORT_GUIDANCE
)]
Create(commands::deploy::create::Args),
#[command(long_about = commands::deploy::init::LONG_ABOUT)]
Init(commands::deploy::init::Args),
#[command(long_about = commands::deploy::debug_logs::LONG_ABOUT)]
DebugLogs(commands::deploy::debug_logs::Args),
Delete(commands::deploy::delete::Args),
Restore(commands::deploy::restore::Args),
}
impl DeployCommands {
fn name(&self) -> &'static str {
match self {
DeployCommands::Approve(_) => "deploy approve",
DeployCommands::GetStatus(_) => "deploy get-status",
DeployCommands::ProvisioningDetails(_) => "deploy provisioning-details",
DeployCommands::PostShare(_) => "deploy post-share",
DeployCommands::Status(_) => "deploy status",
DeployCommands::Create(_) => "deploy create",
DeployCommands::Init(_) => "deploy init",
DeployCommands::DebugLogs(_) => "deploy debug-logs",
DeployCommands::Delete(_) => "deploy delete",
DeployCommands::Restore(_) => "deploy restore",
}
}
}
#[derive(Debug, Subcommand)]
enum AppCommands {
Status(commands::app::status::Args),
List(commands::app::list::Args),
Create(commands::app::create::Args),
Init(commands::app::init::Args),
SetLiveDeploy(commands::app::set_live_deploy::Args),
Delete(commands::app::delete::Args),
}
#[derive(Debug, Subcommand)]
enum KeysCommands {
CreateQuorumKey(commands::keys::create_quorum_key::Args),
GenerateLocalQuorumKey(commands::keys::generate_local_quorum_key::Args),
InitLocalQuorumKey(commands::keys::init_local_quorum_key::Args),
ReEncryptLocalShare(commands::keys::re_encrypt_local_share::Args),
}
impl AppCommands {
fn name(&self) -> &'static str {
match self {
AppCommands::Status(_) => "app status",
AppCommands::List(_) => "app list",
AppCommands::Create(_) => "app create",
AppCommands::Init(_) => "app init",
AppCommands::SetLiveDeploy(_) => "app set-live-deploy",
AppCommands::Delete(_) => "app delete",
}
}
}
impl KeysCommands {
fn name(&self) -> &'static str {
match self {
KeysCommands::CreateQuorumKey(_) => "keys create-quorum-key",
KeysCommands::GenerateLocalQuorumKey(_) => "keys generate-local-quorum-key",
KeysCommands::InitLocalQuorumKey(_) => "keys init-local-quorum-key",
KeysCommands::ReEncryptLocalShare(_) => "keys re-encrypt-local-share",
}
}
}