mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-11 23:02:54 +01:00
53f0d6320e
Co-Authored-By: kotte <14197736+mrtamagotchi@users.noreply.github.com> Co-Authored-By: mikaeltellhed <2311083+mikaeltellhed@users.noreply.github.com> Co-Authored-By: Tore Knudsen <18231882+torekndsn@users.noreply.github.com> Co-Authored-By: Michael Cartner <32543275+michaelcartner@users.noreply.github.com>
45 lines
1.0 KiB
Plaintext
45 lines
1.0 KiB
Plaintext
---
|
|
title: CLI Overview
|
|
hide_title: true
|
|
---
|
|
|
|
# CLI Overview
|
|
|
|
Noodl CLI, or `@noodl/noodl-cli`, is a command-line interface to Noodl for use in your terminal or your scripts.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ npm install -g @noodl/noodl-cli
|
|
```
|
|
|
|
We have a few guides to help you get started with the Noodl CLI.
|
|
To get more information about the Noodl CLI, you can call `noodl-cli help` to see the possible commands.
|
|
|
|
## Authentication
|
|
|
|
Some commands in `noodl-cli` require you to authenticate with Noodl.
|
|
|
|
Set the credentials via environment variables:
|
|
|
|
```bash
|
|
$ export NOODL_USERNAME=<my-email>
|
|
$ export NOODL_PASSWORD=<my-password>
|
|
```
|
|
|
|
You can also pass in the email and password via the command that requires it.
|
|
|
|
```
|
|
$ noodl-cli project clone <project-id> <path> --username <my-email> --password <my-password>
|
|
```
|
|
|
|
## Retrieving workspace id or project id
|
|
|
|
```bash
|
|
$ noodl-cli workspace list --username <my-email> --password <my-password>
|
|
```
|
|
|
|
```bash
|
|
$ noodl-cli project list <workspace-id> --username <my-email> --password <my-password>
|
|
```
|