Skip to content

Commit

Permalink
Update invoke help doc
Browse files Browse the repository at this point in the history
  • Loading branch information
eliangcs committed Oct 10, 2024
1 parent 38eb70e commit 0a81e7c
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ <h2 id="invoke">invoke</h2>
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Invoke an auth operation, a trigger, or a create/search action locally.</p>
</blockquote><p><strong>Usage</strong>: <code>zapier invoke [ACTIONTYPE] [ACTIONKEY]</code></p><p>This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.</p><p>This command loads environment variables and <code>authData</code> from the <code>.env</code> file in the current directory. If you don&apos;t have a <code>.env</code> file yet, you can use the <code>zapier invoke auth start</code> command to help you initialize it, or you can manually create it.</p><p>The <code>zapier invoke auth start</code> subcommand will prompt you for the necessary auth fields and save them to the <code>.env</code> file. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.</p><p>Each line in the <code>.env</code> file should follow one of these formats:</p><ul>
</blockquote><p><strong>Usage</strong>: <code>zapier invoke [ACTIONTYPE] [ACTIONKEY]</code></p><p>This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.</p><p>This command loads environment variables and <code>authData</code> from the <code>.env</code> file in the current directory. If you don&apos;t have a <code>.env</code> file yet, you can use the <code>zapier invoke auth start</code> command to help you initialize it, or you can manually create it.</p><p>The <code>zapier invoke auth start</code> subcommand will prompt you for the necessary auth fields and save them to the <code>.env</code> file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.</p><p>Each line in the <code>.env</code> file should follow one of these formats:</p><ul>
<li><code>VAR_NAME=VALUE</code> for environment variables</li>
<li><code>authData_FIELD_KEY=VALUE</code> for auth data fields</li>
</ul><p>For example, a <code>.env</code> file for an OAuth2 integration might look like this:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ This command emulates how Zapier production environment would invoke your integr

This command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.

The `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.
The `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.

Each line in the `.env` file should follow one of these formats:

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ <h2 id="invoke">invoke</h2>
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Invoke an auth operation, a trigger, or a create/search action locally.</p>
</blockquote><p><strong>Usage</strong>: <code>zapier invoke [ACTIONTYPE] [ACTIONKEY]</code></p><p>This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.</p><p>This command loads environment variables and <code>authData</code> from the <code>.env</code> file in the current directory. If you don&apos;t have a <code>.env</code> file yet, you can use the <code>zapier invoke auth start</code> command to help you initialize it, or you can manually create it.</p><p>The <code>zapier invoke auth start</code> subcommand will prompt you for the necessary auth fields and save them to the <code>.env</code> file. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.</p><p>Each line in the <code>.env</code> file should follow one of these formats:</p><ul>
</blockquote><p><strong>Usage</strong>: <code>zapier invoke [ACTIONTYPE] [ACTIONKEY]</code></p><p>This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.</p><p>This command loads environment variables and <code>authData</code> from the <code>.env</code> file in the current directory. If you don&apos;t have a <code>.env</code> file yet, you can use the <code>zapier invoke auth start</code> command to help you initialize it, or you can manually create it.</p><p>The <code>zapier invoke auth start</code> subcommand will prompt you for the necessary auth fields and save them to the <code>.env</code> file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.</p><p>Each line in the <code>.env</code> file should follow one of these formats:</p><ul>
<li><code>VAR_NAME=VALUE</code> for environment variables</li>
<li><code>authData_FIELD_KEY=VALUE</code> for auth data fields</li>
</ul><p>For example, a <code>.env</code> file for an OAuth2 integration might look like this:</p>
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ This command emulates how Zapier production environment would invoke your integr

This command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.

The `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.
The `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.

Each line in the `.env` file should follow one of these formats:

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/oclif/commands/invoke.js
Original file line number Diff line number Diff line change
Expand Up @@ -1157,7 +1157,7 @@ This command emulates how Zapier production environment would invoke your integr
This command loads environment variables and \`authData\` from the \`.env\` file in the current directory. If you don't have a \`.env\` file yet, you can use the \`zapier invoke auth start\` command to help you initialize it, or you can manually create it.
The \`zapier invoke auth start\` subcommand will prompt you for the necessary auth fields and save them to the \`.env\` file. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.
The \`zapier invoke auth start\` subcommand will prompt you for the necessary auth fields and save them to the \`.env\` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.
Each line in the \`.env\` file should follow one of these formats:
Expand Down

0 comments on commit 0a81e7c

Please sign in to comment.