Skip to content

feat(cli): Add interactive prompts for commands #5170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agusayerza merged 1 commit into from
Jan 14, 2026
Merged

feat(cli): Add interactive prompts for commands #5170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion docs/reference/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,50 @@ Get details about a specific command by running:
nango [command] --help
```

## Interactive Mode

The Nango CLI includes an interactive mode that prompts you for missing arguments. For example, if you run `nango create` without specifying the function type, integration, or name, the CLI will prompt you for them.

This mode is enabled by default when you're in an interactive terminal session.

### Usage Examples

**Interactive Usage:**

If you run a command without all the required arguments, the CLI will prompt you for them.

```bash
# Running "nango create" without arguments
$ nango create

? What type of function do you want to create?
❯ sync
action
on-event
```

**Non-Interactive (Explicit) Usage:**

You can provide all arguments upfront to bypass the interactive prompts. This is ideal for scripting.

```bash
nango create --sync --integration my-api --name get-contacts
```

### Disabling Interactive Mode

You can disable interactive mode in two ways:

1. **Using a flag:** Pass the `--no-interactive` flag to any command.
```bash
nango create --no-interactive
```
2. **In a CI environment:** Interactive mode is automatically disabled when the `CI` environment variable is set. This is the standard way to detect CI/CD environments.

### Backwards Compatibility

Interactive mode is fully backward compatible. If you provide all the required arguments for a command, the CLI will not prompt you for anything and will behave exactly as it did before.

## Flags & environment variables

Global command flags:
Expand All @@ -61,6 +105,9 @@ Global command flags:
# Command flag to auto-confirm all prompts (useful for CI).
# Note: Destructive changes (like removing a sync or renaming a model) requires confirmation, even when --auto-confirm is set. To bypass this restriction, the --allow-destructive flag can be passed to nango deploy.
Copy link
Contributor

@propel-code-bot propel-code-bot bot Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advisory

[Documentation] Fix subject-verb agreement: "Destructive changes ... requires" should be "Destructive changes ... require".

Context for Agents 
[**Documentation**]

Fix subject-verb agreement: "Destructive changes ... requires" should be "Destructive changes ... require".

File: docs/reference/cli.mdx
Line: 106

--auto-confirm

# Command flag to disable interactive mode.
--no-interactive
```

Environment variables:
Expand All @@ -85,4 +132,3 @@ NANGO_DEPLOY_AUTO_CONFIRM=false # Default value
<Tip>
**Questions, problems, feedback?** Please reach out in the [Slack community](https://nango.dev/slack).
</Tip>

Loading
Loading