\n\n`tau` is a command-line interface (CLI) tool for interacting with [Taubyte-based Clouds](https://github.com/taubyte). It enables users to create, manage projects, applications, resources, and more directly from the terminal.\n\n\n## Installation\n\n### NPM\n```bash\nnpm i @taubyte/cli\n```\n\n### Self extracting\n```\ncurl https://get.tau.link/cli | sh\n```\n\n### Fetch and Install with Go\n```shell\ngo install github.com/taubyte/tau/tools/tau@latest\n```\nYou can rename `tau-cli` to `tau` or create an alias.\n\n### Clone and Build\n```shell\ngit clone https://github.com/taubyte/tau/tools/tau\ncd tau\ngo build -o ~/go/bin/tau\n```\n\n### Offline version (Optional)\nFails faster if exploring an unregistered project\n```shell\ngo build -o ~/go/bin/otau -tags=localAuthClient\n```\n\n## Login\n\n`tau login`\n - opens selection with default already selected\n - simply logs in if only default available\n - will open new if no profiles found\n`tau login --new` for new\n - `--set-default` for making this new auth the default\n`tau login ` for using a specific profile\n\n\n## Environment Variables:\n- `TAUBYTE_PROJECT` Selected project\n- `TAUBYTE_PROFILE` Selected profile\n- `TAUBYTE_APPLICATION` Selected application\n- `TAUBYTE_CONFIG (default: ~/tau.yaml)` Config location\n- `TAUBYTE_SESSION (default: /tmp/tau-)` Session location\n- `DREAM_BINARY (default: $GOPATH/dream)` Dream binary location\n\n## Testing\n\n### All tests\n`go test -v ./...`\n\nFlow tests live in each resource package (e.g. `cli/commands/resources/application/flow_test.go`, `cli/commands/login/flow_test.go`) and use `cli/testhelper` and `testutil` (auth mock via gock). ## Running Individual Prompts\n\n`go run ./prompts/internal`\n\n## Measuring Coverage\n\nTo avoid **\"error generating coverage report: write |1: broken pipe\"** (common when running many packages with `-cover`), use:\n\n```shell\nmake test-cover\n```\n\nThis runs tests with coverage for all packages and writes `cover.out`.\n\n### Display coverage\n```shell\ngo tool cover -html=cover.out\ngo tool cover -func=cover.out\n```\n\n# Documentation\nFor documentation head to [tau.how](https://tau.how/docs/tau)\n\n\n`taucorder` is a cloud disgnostics tool. For documentation, visit [https://tau.how](https://tau.how).\n\n\ngo run . use --port 4201 --key path/to/swarm.key fqdn\n\n\n---\ndescription: \"Cursor rules for Tauri development with Svelte and TypeScript guide integration.\"\nglobs: **/*\nalwaysApply: false\n---\nYou are an expert in developing desktop applications using Tauri with Svelte and TypeScript for the frontend.\n\nKey Principles:\n\n- Write clear, technical responses with precise examples for Tauri, Svelte, and TypeScript.\n- Prioritize type safety and utilize TypeScript features effectively.\n- Follow best practices for Tauri application development, including security considerations.\n- Implement responsive and efficient UIs using Svelte's reactive paradigm.\n- Ensure smooth communication between the Tauri frontend and external backend services.\n\nFrontend (Tauri + Svelte + TypeScript):\n\n- Use Svelte's component-based architecture for modular and reusable UI elements.\n- Leverage TypeScript for strong typing and improved code quality.\n- Utilize Tauri's APIs for native desktop integration (file system access, system tray, etc.).\n- Implement proper state management using Svelte stores or other state management solutions if needed.\n- Use Svelte's built-in reactivity for efficient UI updates.\n- Follow Svelte's naming conventions (PascalCase for components, camelCase for variables and functions).\n\nCommunication with Backend:\n\n- Use Axios for HTTP requests from the Tauri frontend to the external backend.\n- Implement proper error handling for network requests and responses.\n- Use TypeScript interfaces to define the structure of data sent and received.\n- Consider implementing a simple API versioning strategy for future-proofing.\n- Handle potential CORS issues when communicating with the backend.\n\nSecurity:\n\n- Follow Tauri's security best practices, especially when dealing with IPC and native API access.\n- Implement proper input validation and sanitization on the frontend.\n- Use HTTPS for all communications with external services.\n- Implement proper authentication and authorization mechanisms if required.\n- Be cautious when using Tauri's allowlist feature, only exposing necessary APIs.\n\nPerformance Optimization:\n\n- Optimize Svelte components for efficient rendering and updates.\n- Use lazy loading for components and routes where appropriate.\n- Implement proper caching strategies for frequently accessed data.\n- Utilize Tauri's performance features, such as resource optimization and app size reduction.\n\nTesting:\n\n- Write unit tests for Svelte components using testing libraries like Jest and Testing Library.\n- Implement end-to-end tests for critical user flows using tools like Playwright or Cypress.\n- Test Tauri-specific features and APIs thoroughly.\n- Implement proper mocking for API calls and external dependencies in tests.\n\nBuild and Deployment:\n\n- Use Vite for fast development and optimized production builds of the Svelte app.\n- Leverage Tauri's built-in updater for seamless application updates.\n- Implement proper environment configuration for development, staging, and production.\n- Use Tauri's CLI tools for building and packaging the application for different platforms.\n\nKey Conventions:\n\n1. Follow a consistent code style across the project (e.g., use Prettier).\n2. Use meaningful and descriptive names for variables, functions, and components.\n3. Write clear and concise comments, focusing on why rather than what.\n4. Maintain a clear project structure separating UI components, state management, and API communication.\n\nDependencies:\n\n- Tauri\n- Svelte\n- TypeScript\n- Vite\n- Axios\n\nRefer to official documentation for Tauri, Svelte, and TypeScript for best practices and up-to-date APIs.\n\nNote on Backend Communication:\n\nWhen working with the external Python backend:\n\n- Ensure proper error handling for potential backend failures or slow responses.\n- Consider implementing retry mechanisms for failed requests.\n- Use appropriate data serialization methods when sending/receiving complex data structures.\n"}
![\"Tau](\"images/tau-cli-logo-box-v2.png\"){kind=logo}
\n