Metadata-Version: 2.5
Name: fieldkit-cli
Version: 1.0.2
Summary: A programmable productivity CLI for account engineering workflows
Project-URL: Documentation, https://github.com/mpeter/fieldkit-cli/tree/main/docs
Project-URL: Issues, https://github.com/mpeter/fieldkit-cli/issues
Project-URL: Repository, https://github.com/mpeter/fieldkit-cli
Maintainer: fieldkit maintainers
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: automation,cli,productivity,salesforce
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: click<9,>=8.1
Requires-Dist: httpx>=0.25
Requires-Dist: jsonschema<5,>=4.23
Requires-Dist: pydantic<3,>=2.0
Requires-Dist: python-dotenv>=1.0.1
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: questionary>=2.0
Requires-Dist: rich>=13.0.0
Requires-Dist: ruamel-yaml<0.20,>=0.18.16
Requires-Dist: tenacity>=8.2
Provides-Extra: all
Requires-Dist: cryptography>=50.0.0; extra == 'all'
Requires-Dist: fastapi>=0.111; extra == 'all'
Requires-Dist: google-api-python-client>=2.131.0; extra == 'all'
Requires-Dist: google-auth-httplib2>=0.2.0; extra == 'all'
Requires-Dist: google-auth-oauthlib>=1.2.0; extra == 'all'
Requires-Dist: google-auth>=2.29.0; extra == 'all'
Requires-Dist: google-cloud-aiplatform>=1.38; extra == 'all'
Requires-Dist: litellm<2,>=1.95; extra == 'all'
Requires-Dist: openai<4,>=1.30; extra == 'all'
Requires-Dist: secretstorage>=3.0; extra == 'all'
Requires-Dist: uvicorn>=0.30; extra == 'all'
Provides-Extra: chrome-auth
Requires-Dist: cryptography>=50.0.0; extra == 'chrome-auth'
Requires-Dist: secretstorage>=3.0; extra == 'chrome-auth'
Provides-Extra: google
Requires-Dist: google-api-python-client>=2.131.0; extra == 'google'
Requires-Dist: google-auth-httplib2>=0.2.0; extra == 'google'
Requires-Dist: google-auth-oauthlib>=1.2.0; extra == 'google'
Requires-Dist: google-auth>=2.29.0; extra == 'google'
Provides-Extra: llm
Requires-Dist: google-cloud-aiplatform>=1.38; extra == 'llm'
Requires-Dist: litellm<2,>=1.95; extra == 'llm'
Requires-Dist: openai<4,>=1.30; extra == 'llm'
Provides-Extra: web
Requires-Dist: fastapi>=0.111; extra == 'web'
Requires-Dist: uvicorn>=0.30; extra == 'web'
Description-Content-Type: text/markdown

# fieldkit

[![CI](https://github.com/mpeter/fieldkit-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/mpeter/fieldkit-cli/actions/workflows/ci.yml)
[![Artifact compatibility](https://github.com/mpeter/fieldkit-cli/actions/workflows/compatibility.yml/badge.svg)](https://github.com/mpeter/fieldkit-cli/actions/workflows/compatibility.yml)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
[![Python](https://img.shields.io/badge/python-3.11%20%E2%80%93%203.14-blue.svg)](docs/compatibility.md)

fieldkit is a local-first command-line workspace for structured sales and account
work. It combines Markdown-based pursuits and tasks with optional Salesforce,
Google, AI, web, and organization-provided integrations. Your workspace remains
separate from the application and under your control.

A source version is not a published release. Publication is established only by
an immutable release record with a signed tag, GitHub release, and package
artifacts; see [Release history](docs/releases.md) to verify published versions.
Future product work is tracked in the [roadmap](ROADMAP.md).

## Quickstart: try the portable core

You need Python 3.11 or newer and
[`uv`](https://docs.astral.sh/uv/getting-started/installation/).

```console
uv tool install fieldkit-cli
```

After installation, create and verify a credential-free local workspace:

```console
fieldkit init --minimal ./fieldkit-workspace
fieldkit doctor
fieldkit skill list
```

The workspace commands create a generic local workspace, make it active in your
fieldkit user configuration, and exercise the installed package without
credentials or configured external services. See
[Installation and first success](docs/getting-started.md) for source installs,
optional profiles, expected results, and cleanup.

## What it can do

- Create and validate local pursuit workspaces.
- Audit, forecast, and advance structured opportunity notes.
- Run local watchers and assemble a morning brief.
- Add Salesforce and Gmail context when you configure those services.
- Enable AI-assisted, local web, browser-auth, or organization-provided
  capabilities independently.
- Expose stable text, Markdown, and JSON output for scripts and agents.

Start with [What fieldkit does](docs/user-guide.md), then choose integrations from
[Integrations and profiles](docs/integrations.md). Read
[Local data and privacy](docs/privacy.md) before using real account or customer
information.

## Install a capability profile

The base package is intentionally small. Add only what you use:

```console
uv tool install 'fieldkit-cli[google]'
uv tool install 'fieldkit-cli[llm]'
uv tool install 'fieldkit-cli[web]'
uv tool install 'fieldkit-cli[chrome-auth]'
uv tool install 'fieldkit-cli[all]'
```

Installing a profile provides its Python dependencies; it does not configure a
provider, grant access, or send data anywhere.

## Contribute

fieldkit welcomes bug reports, documentation, tests, code, design discussion,
and issue triage. A contributor checkout has one supported setup path:

```console
git clone https://github.com/<your-user>/fieldkit-cli.git
cd fieldkit-cli
make bootstrap
make pr-check
```

Read [CONTRIBUTING.md](CONTRIBUTING.md) before starting. Project authority is
described in [GOVERNANCE.md](GOVERNANCE.md), support routes in
[SUPPORT.md](SUPPORT.md), and private vulnerability reporting in
[SECURITY.md](SECURITY.md).

Maintainers preparing a release should follow [RELEASING.md](RELEASING.md).

Dependency changes follow the [dependency security policy](docs/dependency-security.md), including
license review, locked-graph auditing, and narrow exception requirements.

## Compatibility and status

The portable core is tested on CPython 3.11 through 3.14 on Ubuntu and macOS,
with a Fedora/RHEL-family container smoke path. Native Windows is experimental.
Individual integrations can have narrower platform or access requirements; see
[Compatibility](docs/compatibility.md).

The public compatibility contract for 1.x and the distinction between supported
and internal interfaces are documented in [Product model](docs/concepts.md).

## License

fieldkit is licensed under the [Apache License 2.0](LICENSE).
