You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/cli.mdx
+47-1Lines changed: 47 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,50 @@ Get details about a specific command by running:
53
53
nango [command] --help
54
54
```
55
55
56
+
## Interactive Mode
57
+
58
+
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.
59
+
60
+
This mode is enabled by default when you're in an interactive terminal session.
61
+
62
+
### Usage Examples
63
+
64
+
**Interactive Usage:**
65
+
66
+
If you run a command without all the required arguments, the CLI will prompt you for them.
67
+
68
+
```bash
69
+
# Running "nango create" without arguments
70
+
$ nango create
71
+
72
+
? What type of functiondo you want to create?
73
+
❯ sync
74
+
action
75
+
on-event
76
+
```
77
+
78
+
**Non-Interactive (Explicit) Usage:**
79
+
80
+
You can provide all arguments upfront to bypass the interactive prompts. This is ideal for scripting.
1.**Using a flag:** Pass the `--no-interactive` flag to any command.
91
+
```bash
92
+
nango create --no-interactive
93
+
```
94
+
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.
95
+
96
+
### Backwards Compatibility
97
+
98
+
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.
99
+
56
100
## Flags & environment variables
57
101
58
102
Global command flags:
@@ -61,6 +105,9 @@ Global command flags:
61
105
# Command flag to auto-confirm all prompts (useful for CI).
62
106
# 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.
63
107
--auto-confirm
108
+
109
+
# Command flag to disable interactive mode.
110
+
--no-interactive
64
111
```
65
112
66
113
Environment variables:
@@ -85,4 +132,3 @@ NANGO_DEPLOY_AUTO_CONFIRM=false # Default value
85
132
<Tip>
86
133
**Questions, problems, feedback?** Please reach out in the [Slack community](https://nango.dev/slack).
0 commit comments