Metadata-Version: 2.1
Name: sym-flow-cli
Version: 0.0.62
Summary: The Flow CLI for Sym
Home-page: https://github.com/symopsio/sym-flow-cli
Author: SymOps, Inc.
Author-email: pypi@symops.io
Requires-Python: >=3.8,<4.0
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyYAML (>=5.3.1,<6.0.0)
Requires-Dist: analytics-python (>=1.2.9,<2.0.0)
Requires-Dist: boto3 (>=1.16.20,<2.0.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: immutables (>=0.14,<0.15)
Requires-Dist: pkce (>=1.0,<2.0)
Requires-Dist: policy-sentry (==0.9.0)
Requires-Dist: policyuniverse (>=1.3.2,<2.0.0)
Requires-Dist: portalocker (>=2.0.0,<3.0.0)
Requires-Dist: sentry-sdk (>=0.19.3,<0.20.0)
Requires-Dist: sym-cli (>=0.0.60,<0.0.61)
Requires-Dist: validators (>=0.18.1,<0.19.0)
Project-URL: Repository, https://github.com/symopsio/sym-flow-cli
Description-Content-Type: text/markdown

# sym-flow-cli

Sym Flow CLI

## Usage

### Login

`symflow login` is used to authenticate a user and write credentials to the local filesystem. 

First, the CLI asks a user for their email address. From the address, Sym should be able to resolve the user's 
organization and then the user can log in with one of two authorization flows:

#### (Preferred) Auth Code Flow with PKCE

`symflow login`

The CLI will perform authorization with the Sym auth provider, by opening the browser and asking the user
to login with their Identity Provider. If successful, this returns a code to the CLI that can be used to 
securely acquire an access token. 

#### (If necessary) Password Owner Resource Flow

`symflow login --no-browser` can be used to perform a username-password flow. It will prompt the user, and then 
send these credentials to the Sym auth provider in exchange for an access token. 

This requires special setup in the Sym auth provider to verify the password against a database connection. 

