Skip to main content

ChatFAQ Command Line Interface (CLI) Tool

The full potential of ChatFAQ services, datasets, and models at the tip of your fingers.

Prerequisites

Make sure the next list of packages are installed on your system:

  • Python 3.10
  • poetry

Installation

Local build

poetry install

PYPI

pip install chatfaq-cli

Usage

First of all you should configure the remote target server:

chatfaq config host <REMOTE_ADRESS>

Then you can log in into the remote server:

chatfaq config auth <TOKEN>

You can retrieve the auth token from the backend server:

curl -X POST -u username:password http://localhost:8000/back/api/login/

by using an admin's user and password.

Commands

chatfaq --help

Publish package

PYPI test

add repository to poetry config

poetry config repositories.chatfaq-cli https://test.pypi.org/legacy/

get token from https://test.pypi.org/manage/account/token/

store token using

poetry config pypi-token.chatfaq-cli pypi-YYYYYYYY

PYPI production

get token from https://pypi.org/manage/account/token/

store token using

poetry config pypi-token.chatfaq-cli pypi-XXXXXXXX

Each time you need to publish

Bump version

poetry version prerelease

or

poetry version patch

Poetry Build

poetry build

Poetry Publish

To TestPyPi

poetry publish -r chatfaq-cli

To PyPi

poetry publish

Metadata

Release files for chatfaq_cli 0.1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chatfaq_cli 0.1.9
File Size Uploaded Provenance Actions
chatfaq_cli-0.1.9.tar.gz 9.8 kB Without provenance Details for chatfaq_cli-0.1.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for chatfaq_cli 0.1.9
File Interpreter ABI Platform Actions
chatfaq_cli-0.1.9-py3-none-any.whl Python 3 none any Details for chatfaq_cli-0.1.9-py3-none-any.whl

Total release size: 26.1 kB

Release files / chatfaq_cli-0.1.9.tar.gz

Download URL chatfaq_cli-0.1.9.tar.gz
Size 9.8 kB
Tags Source
SHA-256 checksum
How to use checksums
916dabfa4948ad7ca72c6d9bac70c277ea9f72d281b62340469fe25f320d7a47
BLAKE2b-256 checksum
How to use checksums
0af7d5c7073d2aefbfe0170b3e791ea1646c72d01f8c14ccaa76c1f2237a4fe8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.8.10 Linux/5.14.0-1059-oem

Release files / chatfaq_cli-0.1.9-py3-none-any.whl

Download URL chatfaq_cli-0.1.9-py3-none-any.whl
Size 16.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
227984a15383e0c48773dabb2f3dc8396627fb3f7703fe069af7177d7189cc4c
BLAKE2b-256 checksum
How to use checksums
50cc194bf5a6eade31d5f4ed62485deb5c87aaa13ff435d2a90ead617a944321
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.8.10 Linux/5.14.0-1059-oem

Security for chatfaq_cli 0.1.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.9 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page