---
id: cloudshell-shell-core
version: "6.0.2"
license: Apache 2.0
license_treatment: permissive
maintenance: active
---

# cloudshell-shell-core — Core package for all CloudShell Shells. This package contains the basic driver interfaces and metadata definitions as well as utilities and helpers created specifically for Shells

License: permissive · Maintenance: active · Downloads: 118.5K/mo

## What it is and what it does

cloudshell-shell-core is the foundational package for building CloudShell shells—the driver plugins that CloudShell uses to manage and orchestrate resources in a sandbox environment. It defines the ResourceDriverInterface that all shells must implement, provides context objects that CloudShell passes to shell commands, and wraps the cloudshell-automation-api and cloudshell-logging libraries to simplify common tasks like setting live status, writing output, and logging.

Developers use this package as the base when creating new shells via shellfoundry or when implementing custom resource drivers. It abstracts away much of the boilerplate needed to communicate with the CloudShell platform, letting you focus on the logic specific to your resource type. The package supports Python 3.7 and later and is marked as Production/Stable.

Use it for:

- Build a custom CloudShell shell driver for a new resource type by inheriting from ResourceDriverInterface.
- Wrap CloudShell Automation API calls to set live status or write messages to the sandbox output log.
- Implement structured logging in a shell driver using the provided LoggingSessionContext wrapper.
- Access driver context objects (resource details, sandbox info, etc.) passed by CloudShell to your shell commands.
- Integrate a shell into the CloudShell ecosystem by using the standard driver interface and context definitions.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides the base driver interface and context objects that CloudShell shells use to interact with the CloudShell platform, including wrappers for the automation API and logging.

Yes, if you are developing CloudShell shells or resource drivers. It is a production-stable, actively maintained package with low install friction and permissive licensing. No known vulnerabilities. Install only if you are working within the CloudShell platform; it is not a general-purpose library.

## Install

pip install cloudshell-shell-core
uv add cloudshell-shell-core
poetry add cloudshell-shell-core

## Installing cloudshell-shell-core

Before you install: Low install friction with a pure-Python wheel distribution. Actively maintained with a recent commit history and marked as Production/Stable. Five runtime dependencies are all from the CloudShell ecosystem, suggesting a cohesive, well-integrated package.

License in practice: Licensed under Apache 2.0 (permissive), allowing use in commercial and open-source projects with minimal restrictions—you must include a copy of the license and note any modifications.

Quickstart:

pip install cloudshell-shell-core

from cloudshell.shell.core.resource_driver_interface import ResourceDriverInterface

class MyDriver(ResourceDriverInterface):
    pass

Requires Python 3.7 or later; Python 3 is required as of version 5.0.x.

Verify before relying:

- Whether the package is actively maintained beyond the last commit date (2026-06-25); the repository shows only 1 star, which may indicate limited adoption or visibility.
- Specific CloudShell version compatibility for version 6.0.2; the description references CloudShell 9.3.0 but does not specify which versions this release supports.

## Package facts

- License: Apache 2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 118.5K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

cloudshell shell driver interface, cloudshell resource driver, cloudshell automation api wrapper, cloudshell shell development, cloudshell logging context, cloudshell sandbox driver, cloudshell shell framework, cloudshell-ecosystem, resource-driver, sandbox-orchestration

[View on SkillFed](https://skillfed.io/packages/cloudshell-shell-core) · [View on PyPI](https://pypi.org/project/cloudshell-shell-core/)