Distributing via registry

Distribute, share, and maintain tiles through the Tessl Registry

Once you've created and published a tile, you'll need to share it with your team, keep it updated, and manage its lifecycle. This guide covers the common tasks for managing published tiles.

Sharing with your team

Add members to your workspace so they can access your private tiles:

tessl workspace add-member --user <tessl-user-id> --role member --workspace myworkspace

The member role gives read-only access to tiles. See Roles for more information about workspace roles and permissions.

To verify members have been added:

tessl workspace list-members myworkspace

Installing tiles in projects

Team members can install your tile in their projects:

tessl install myworkspace/your-tile

Or search for it:

tessl search your-tile

Private tiles appear in search results for workspace members just like public tiles.

To install a specific version:

tessl install myworkspace/[email protected]

Updating documentation

When your library or service changes, update the tile to keep documentation current.

For automated tiles

If you used automated generation from a repository:

1. Merge code changes to your repository

2. Navigate to the Tessl interface and regenerate the tile

3. Review new evaluation results

4. Publish the updated version

See Autogenerating documentation for details on the automated workflow.

For manual tiles

If you created the tile manually:

1. Edit your documentation files

2. Increment the version in tile.json (following semantic versioning)

3. Validate with tessl tile lint

4. Publish with tessl tile publish

Version guidelines:

• Patch (1.0.0 → 1.0.1): Bug fixes, typo corrections

• Minor (1.0.0 → 1.1.0): New content, backward-compatible changes

• Major (1.0.0 → 2.0.0): Restructuring, breaking changes

Users can update to the latest version:

tessl install myworkspace/your-tile

See Creating documentation for details on the manual workflow.

Archiving tiles

To remove a tile from search results without deleting it:

tessl tile archive --tile myworkspace/[email protected] --reason "replaced by new library"

Archived tiles:

• No longer appear in search results

• Cannot be installed by new users

• Remain accessible to projects that already have them installed

• Can be restored by contacting support

Use archiving when:

• A library is deprecated but still used by some projects

• You're migrating to a new tile and want to phase out the old one

• The tile is outdated but may still be needed for reference

Unpublishing tiles

To completely remove a tile within 2 hours of upload:

tessl tile unpublish --tile myworkspace/[email protected]

Important: Unpublishing is only available within 2 hours of the original publish. After that, use archiving instead.

Unpublished tiles are completely removed and cannot be recovered.

Monitoring tile usage

Track how your tiles are being used:

1. Navigate to the Tessl Registry

2. Log in and select your workspace

3. View your tiles to see usage statistics and install counts

This helps you understand which tiles are most valuable to your team.

Best practices

• Update regularly - Keep documentation in sync with code changes

• Use semantic versioning - Help users understand the impact of updates

• Archive deprecated tiles - Guide users to replacement tiles

• Monitor usage - Focus maintenance effort on widely-used tiles

• Document breaking changes - Communicate major version updates to your team

Related

• Autogenerating documentation - Automated tile creation

• Creating documentation - Manual tile creation

• Workspaces - Understanding workspaces and permissions

• Configuration files - Complete tile.json reference