Metadata-Version: 2.4
Name: telekinesis-deployment
Version: 0.0.3
Summary: Installer and CLI for the Telekinesis deployment stack.
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: docker==7.1.0
Requires-Dist: loguru==0.7.3
Requires-Dist: requests==2.33.1
Dynamic: license-file

<div align="center">
  <p>
    <a href="https://telekinesis.ai" target="_blank">
      <img
        width="100%"
        src="https://assets.telekinesis.ai/logo/telekinesis-banner.png"
        alt="Telekinesis"
      >
    </a>
  </p>

  <br>

  [![Python versions](https://img.shields.io/badge/python-3.11%20%7C%203.12-blue)](https://www.python.org/)
  [![License](https://img.shields.io/badge/license-proprietary-lightgrey)](LICENSE.txt)
</div>

<p align="center">
  <a href="https://github.com/telekinesis-ai">GitHub</a>
  &nbsp;&bull;&nbsp;
  <a href="https://www.linkedin.com/company/telekinesis-ai/">LinkedIn</a>
  &nbsp;&bull;&nbsp;
  <a href="https://x.com/telekinesis_ai">X</a>
  &nbsp;&bull;&nbsp;
  <a href="https://discord.gg/7NnQ3bQHqm">Discord</a>
</p>

# Telekinesis Deployment

Telekinesis Deployment provides the installation tooling and backend delivery
workflows for the Telekinesis platform.


## Release Model

Telekinesis Deployment is currently in active development (pre-1.0). Features
and interfaces may evolve between minor releases. Use the version specified by
the Telekinesis development team for production deployments.


## Requirements

Before installing Telekinesis Deployment, make sure you have: 
- A valid Telekinesis license key
- Docker installed and running
- Docker Compose available


## Installation

The installer scripts install the Telekinesis Deployment CLI and its required dependencies.

### Windows
```bash
Invoke-WebRequest `
  -Uri "https://assets.telekinesis.ai/telekinesis-deployment/install.ps1" `
  -OutFile install.ps1
powershell -ExecutionPolicy Bypass -File .\install.ps1
```

### Linux/macOS
```bash
curl -fsSL https://assets.telekinesis.ai/telekinesis-deployment/install.sh | sh
```

## Example

Start all the services:

```bash
telekinesis server up
```

View the available server commands:

```bash
telekinesis server --help
```

## Resources

- All module examples are available in [Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples)
- Full SDK documentation and usage details: [Telekinesis Documentation](https://docs.telekinesis.ai)

## Support

For issues and questions:

- Create an [issue](https://github.com/telekinesis-ai/telekinesis-examples/issues) in the GitHub repository.
- Contact the Telekinesis development team at support@telekinesis.ai or on [Discord](https://discord.com/invite/7NnQ3bQHqm).
