Metadata-Version: 2.1
Name: mfn-cli
Version: 0.8.0
Summary: KNIX MicroFunctions Command Line Interface
Home-page: https://github.com/knix-microfunctions/knix
Author: The KNIX authors
Author-email: knix-dev@list.nokia.com
License: Apache-2.0
Description: <!--
           Copyright 2020 The KNIX Authors
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        -->
        # MicroFunctions Command Line Interface
        
        The package provides the mfn command based on the [SDK](../mfn_sdk/).
        
        The latest version of the CLI can be obtained with [KNIX releases](https://github.com/knix-microfunctions/knix/releases/).
        After downloading, one can install it:
        ``` sh
        pip3 install --user <mfn_sdk_path>
        pip3 install --user <mfn_cli_path>
        ```
        
        ## Using the cli
        
        ### mfn login
        
        The login action is used to obtain a valid user token for all subsequent operations.
        The token will be updated/stored in ~/.mfn/config.yaml
        
        ``` sh
        mfn login [--url <url>] [--user <username>] [--password <password>]
        ```
        
        ``` sh
        $ mfn login --url https://knix.io/mfn --user test@test
        Logging into https://knix.io/mfn as user test@test
        Please enter the password: ************
        $
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
