https://github.com/flotiq/flotiq-setup

Flotiq-setup helps you easily authenticate your local project with Flotiq
https://github.com/flotiq/flotiq-setup

Last synced: 15 days ago
JSON representation

Flotiq-setup helps you easily authenticate your local project with Flotiq

• Host: GitHub
• URL: https://github.com/flotiq/flotiq-setup
• Owner: flotiq
• License: mit
• Created: 2024-04-20T21:23:08.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T08:17:20.000Z (22 days ago)
• Last Synced: 2024-10-29T08:31:17.360Z (22 days ago)
• Language: JavaScript
• Size: 47.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



flotiq-setup

============

This command makes it super-easy to fill in the local `.env` files with Flotiq API key.

By default the Global Read-Only key is used.

## Quickstart

```bash

npx flotiq-setup

```

## Usage

```

Use flotiq-setup to authenticate your local project using Global Read-Only key

Commands:

  index.mjs flotiq-setup [options]  Connect the project with Flotiq

Options:

      --version   Show version number                                        [boolean]

  -a, --authUrl   Authentication endpoint                                    [string]  [default: "https://editor.flotiq.com/login"]

  -r, --ro-key    Return Read only Flotiq api key as FLOTIQ_API_KEY          [boolean] [default: true]

  -w, --rw-key    Return Read and Write Flotiq api key as FLOTIQ_RW_API_KEY  [boolean] [default: false]

  -s, --silent    Suppress console output. Assumes no for all prompts.       [boolean] [default: false]

  -n, --no-store  Disable saving Flotiq api keys into env files              [boolean] [default: false]

  -h, --help      Show help                                                  [boolean]

```

## Surpressing output messages

If you don't want to receive output messages, pass `--silent`/`-s` option to limit number of logs.

```bash

npx flotiq-setup --silent

```

This is especially useful when you are using `flotiq-setup` with other automation tools or you are running setup function by hand.

## Node.js api

You can use command handler in your scripts by importing command handler

```javascript

const {handler} = require('flotiq-setup/commands/setup');

await handler({authUrl: 'https://editor.flotiq.com/login', roKey: true, rwKey: true, silent: false, noStore: false});

```

## Collaborating

If you wish to talk with us about this project, feel free to hop on

our [![Discord Chat](https://img.shields.io/discord/682699728454025410.svg)](https://discord.gg/FwXcHnX).

If you found a bug, please report it in [issues](https://github.com/flotiq/flotiq-setup).