team-flow-client 0.1.0

Cross-platform console client for Team Flow

Team Flow Client

tfc is the cross-platform command-line client for Team Flow. It stores project settings in a local .tfc/config.json, tracks an idea, sends errors and hypotheses to Team Flow Server, and publishes code snapshots to GitHub.

Requirements

• Python 3.10 or newer;
• Git 2.28 or newer;
• Git Credential Manager for browser-based GitHub authentication.

Git Credential Manager is included with Git for Windows. On macOS install it with:

brew install --cask git-credential-manager

Installation

python -m pip install team-flow-client

The package installs the tfc command through Python's standard console-script entry point. It can be invoked from any directory:

tfc --version
tfc --help

For an isolated global CLI installation, pipx install team-flow-client is also supported.

Quick start

Open the root directory of a code project and run:

tfc init

The client creates .tfc/config.json, configures the Team Flow server, GitHub authentication, repository, branch and commit author, and then creates or selects the first idea.

Set a server by IP address:

tfc config server-ip 192.168.1.20
tfc config server-ip 192.168.1.20 --port 8080
tfc config server-ip 2001:db8::10 --https --port 443

Commands

tfc init
tfc idea
tfc idea create
tfc tree
tfc config show
tfc config server URL
tfc config server-ip IP [--port PORT] [--https]
tfc config git REPOSITORY BRANCH
tfc config author NAME EMAIL
tfc config auth [USERNAME] [--force]
tfc send err [TEXT]
tfc send hyp [CAUSE] [--fix FIX]

Run tfc --help for the complete command reference.

Source

Repository: https://github.com/siriusmts/command-flow