Skip to content

supadef/cli

Repository files navigation

Supadef PyPi Package / CLI

Overview

The supadef python package lets you define how your Python functions run in the cloud using decorators like @task.

The supadef CLI tool allows you to interact with the Supadef platform. You can use it to manage projects, functions, and deployments.

Commands

supadef connect
  • Make a test connection with the platform. Verifies that your auth credentials saved at ~/.supadef/credentials.yml are configured correctly. Returns the email of the authenticated user.
supadef create [project]
  • Create a new project with the given name in your account. Project names must be unique across all Supadef projects.
supadef projects
  • List the projects in your account. Includes information on your project's deployment state.
supadef push [project] [path/to/code_dir]
  • Push the source code you specify to the cloud. Appropriately configured functions will be available to run on demand in the cloud. Source code directory must be a git repo. Anything in .gitignore will not be uploaded.
supadef run [project] 'your_function' '{ "arg1":  "drums", "arg2": [1, 2, 3, 4] }' [version]
  • Run a function in the cloud. [version] will soon be optional, or removed, to simplify the interface. Returns a task_id, for use with getting logs.
supadef logs [project] [task_id]
  • Get the logs for a particular function run.
supadef set_env [project] [~/path/to/.env]
  • Securely upload an environment file (.env) to your project
supadef destroy [project]
  • Destroy a project and all resources associated with it.

Distribution

PyPI Package: https://pypi.org/project/supadef/

Github Repo: https://github.com/supadef/cli

Releases

No releases published

Packages

No packages published