fieldkit

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 to verify published versions. Future product work is tracked in the roadmap.

Quickstart: try the portable core

You need Python 3.11 or newer and uv.

uv tool install fieldkit-cli

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

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 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, then choose integrations from Integrations and profiles. Read Local data and privacy before using real account or customer information.

Install a capability profile

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

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:

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

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

Maintainers preparing a release should follow RELEASING.md.

Dependency changes follow the dependency security policy, 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.

The public compatibility contract for 1.x and the distinction between supported and internal interfaces are documented in Product model.

License

fieldkit is licensed under the Apache License 2.0.