Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
63 changes: 61 additions & 2 deletions docs/CommandLineHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ This document contains the help content for the `screenly` command-line program.
* [`screenly`↴](#screenly)
* [`screenly login`↴](#screenly-login)
* [`screenly logout`↴](#screenly-logout)
* [`screenly me`↴](#screenly-me)
* [`screenly auth`↴](#screenly-auth)
* [`screenly auth list`↴](#screenly-auth-list)
* [`screenly auth switch`↴](#screenly-auth-switch)
* [`screenly screen`↴](#screenly-screen)
* [`screenly screen list`↴](#screenly-screen-list)
* [`screenly screen get`↴](#screenly-screen-get)
Expand Down Expand Up @@ -58,6 +62,8 @@ Command line interface is intended for quick interaction with Screenly through t

* `login` — Logs in with the provided token and stores it for further use if valid. You can set the API_TOKEN environment variable to override the stored token
* `logout` — Logs out and removes the stored token
* `me` — Show information about the currently authenticated profile
* `auth` — Manage stored authentication profiles
* `screen` — Screen related commands
* `asset` — Asset related commands
* `playlist` — Playlist related commands
Expand All @@ -74,15 +80,68 @@ Command line interface is intended for quick interaction with Screenly through t

Logs in with the provided token and stores it for further use if valid. You can set the API_TOKEN environment variable to override the stored token

**Usage:** `screenly login`
**Usage:** `screenly login [OPTIONS]`

###### **Options:**

* `--name <NAME>` — Profile name to store the token under. Required when other profiles already exist



## `screenly logout`

Logs out and removes the stored token

**Usage:** `screenly logout`
**Usage:** `screenly logout [OPTIONS]`

###### **Options:**

* `--name <NAME>` — Profile name to remove. Removes the active profile if not specified



## `screenly me`

Show information about the currently authenticated profile

**Usage:** `screenly me [OPTIONS]`

###### **Options:**

* `-j`, `--json` — Enables JSON output



## `screenly auth`

Manage stored authentication profiles

**Usage:** `screenly auth <COMMAND>`

###### **Subcommands:**

* `list` — List stored authentication profiles
* `switch` — Switch the active authentication profile



## `screenly auth list`

List stored authentication profiles

**Usage:** `screenly auth list`



## `screenly auth switch`

Switch the active authentication profile

**Usage:** `screenly auth switch [NAME]`

###### **Arguments:**

* `<NAME>` — Profile name to activate



Expand Down
Loading
Loading