Metadata-Version: 2.4
Name: team-flow-client
Version: 0.1.2
Summary: Cross-platform console client for Team Flow
Author: Team Flow
Project-URL: Homepage, https://github.com/siriusmts/command-flow
Project-URL: Repository, https://github.com/siriusmts/command-flow
Project-URL: Issues, https://github.com/siriusmts/command-flow/issues
Keywords: team-flow,ideas,hypotheses,git,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# 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.

When creating an idea, another idea can be selected as its source. The branch
is anchored to the source's latest hypothesis, or directly to its root idea
block when no hypothesis exists yet.

## 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:

```bash
brew install --cask git-credential-manager
```

## Installation

```bash
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:

```bash
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:

```bash
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.

If the selected GitHub branch already contains commits but the current project
directory has no initialized Git repository, `tfc` initializes Git, connects
the remote and downloads the branch files automatically. Existing local files
are never silently overwritten when they conflict with remote files.

Set a server by IP address:

```bash
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

```text
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
