# Farseer Client

> TypeScript SDK for the Farseer Platform. Install with `npm install farseer-client`. All operations start with `new FarseerClient()` which auto-configures from TENANT_ID, FARSEER_API_KEY, and FARSEER_URL environment variables.

For the full documentation in a single file, see: https://client-docs.farseer.io/llms-full.txt

## Getting Started

- [Installation](https://client-docs.farseer.io/getting-started/installation): npm install, requirements, environment setup
- [Authentication](https://client-docs.farseer.io/getting-started/authentication): Three auth methods — env vars, constructor params, or custom config
- [Quick Start](https://client-docs.farseer.io/getting-started/quick-start): Quick reference for all main operations

## Guides

- [Import Workflows](https://client-docs.farseer.io/guides/import-workflows): Import data into Farseer variables with createImportJob()
- [Exporting Data](https://client-docs.farseer.io/guides/export-data): Export variables and dimension tables using exportFormula() and loadFarseerVariable()
- [Evaluating Formulas](https://client-docs.farseer.io/guides/evaluator): Compute cell values with evaluator.evaluate() and CellQuery
- [Model Management](https://client-docs.farseer.io/guides/model-management): Sync dimension table structure with model.load()
- [File Operations](https://client-docs.farseer.io/guides/file-operations): Navigate folders, download/upload files, work with Excel
- [Arquero Patterns](https://client-docs.farseer.io/guides/arquero-patterns): Data transformation with Arquero tables, aq.escape(), dimension connections
- [External APIs](https://client-docs.farseer.io/guides/external-apis): RESTApi class for consuming third-party APIs with pagination
- [New App Template](https://client-docs.farseer.io/guides/new-app-template): Project structure, dev/prod pattern, error handling

## API Reference

- [FarseerClient](https://client-docs.farseer.io/api-reference/farseer-client): Main class — constructor, tag management, folders, imports, files, 37 API modules
- [FarseerClientData](https://client-docs.farseer.io/api-reference/farseer-client-data): Data module — loadFarseerDimensionTable, loadFarseerVariable, importDataTable, syncMultipleTables
- [Evaluator & Cells](https://client-docs.farseer.io/api-reference/evaluator-api): evaluator.evaluate(), cells.calculateOnDemandCells(), cell operations
- [RESTApi](https://client-docs.farseer.io/api-reference/rest-api): External REST API consumer with 3 auth types
- [Types](https://client-docs.farseer.io/api-reference/types): TagRepresentation, ImportActions, CellQuery, ExportConfiguration, etc.

## Resources

- [Examples](https://client-docs.farseer.io/examples): 8 runnable examples covering all major use cases
- [Troubleshooting](https://client-docs.farseer.io/troubleshooting): Common errors and debugging tips