Basic usage

The writer cloud command group includes the following commands:

  • deploy
  • undeploy
  • logs

Common options

These options are common across multiple commands:

  • --api-key: The Writer API key used for authentication. If not provided, you will be prompted to enter it.
  • --verbose, -v: Enable verbose output.

Commands

Environment variables

When deploying an app, you can specify environment variables that will be available to the app during runtime. Use the --env option to pass these variables.

writer cloud deploy hello --env DB_HOST=db.example.com --env DB_PORT=5432

In this example, DB_HOST and DB_PORT will be available to the app as environment variables.

API key

The WRITER_API_KEY is crucial for deploying and managing apps. It is used for authenticating requests to the Writer cloud. If not provided as an option, the CLI will prompt you to enter it. The WRITER_API_KEY will also be added to the deployed app’s environment to enable AI features of the Writer framework.

Deployment process

1

Package Creation

The CLI packages the app, excluding certain files (e.g., Dockerfile, service_entrypoint.py).

2

Upload Package

The package is uploaded to the Writer deployment server.

3

Build and Deploy

The server builds and deploys the app, making it accessible via a URL.

4

Environment Variables

Specified environment variables are set, and WRITER_API_KEY is added by default.

Example workflow

1

Deploying an App

writer cloud deploy /path/to/app --env DB_HOST=db.example.com --env DB_PORT=5432
2

Fetching Logs

writer cloud logs
3

Undeploying an App

writer cloud undeploy

By following this documentation, you should be able to effectively deploy and manage your Writer apps using the Writer Framework CLI.