Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
269 changes: 269 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
### JetBrains template
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# AWS User-specific
.idea/**/aws.xml

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# SonarLint plugin
.idea/sonarlint/

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### macOS template
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/

_autosummary
_tmp
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ check: lint types
tests: check
uv run pytest --cov=contree_cli --cov-report=term-missing

docs-mintlify:
$(MAKE) -C docs mintlify

docs:
$(MAKE) -C docs html

Expand Down
10 changes: 10 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,15 @@ help:
html:
$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)

mintlify-build:
$(SPHINXBUILD) -b mintlify "$(SOURCEDIR)" "$(BUILDDIR)/mintlify" $(SPHINXOPTS)

mintlify-clean:
rm -rf $(BUILDDIR)/mintlify

mintlify:
$(MAKE) mintlify-clean
$(MAKE) mintlify-build

clean:
rm -rf $(BUILDDIR)
4 changes: 4 additions & 0 deletions docs/commands/agent.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: robot
---

# agent - Coding-agent manual

Display the coding-agent manual — a guide for AI agents and automated
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/auth.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: key
---

# auth - Configure credentials and profiles

Configure authentication tokens and manage profiles. Each profile stores
Expand Down
5 changes: 5 additions & 0 deletions docs/commands/build.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
icon: hammer
---

% build command reference for the Docker-style Dockerfile interpreter

# build - Build an image from a Dockerfile

Build an image from a `Dockerfile`. Each directive runs against the
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/cat.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: file-lines
---

# cat - Show file content from the image

Display the contents of a file from the session image.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/cd.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: folder
---

# cd - Change session working directory

Change the working directory for subsequent commands in the current session.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/cp.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: copy
---

# cp - Download a file from the image

Download a file from the session image to a local path.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/env.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: leaf
---

# env - Manage session environment variables

Manage session-level environment variables. Variables set with `env` are
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/file.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: file
---

# file - Stage file edits for the next run

Stage file changes for the next `contree run`. Pending files are
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/images.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: layer-group
---

# images - List and import images

List images in the project. Images are the filesystem snapshots that sandboxes
Expand Down
5 changes: 4 additions & 1 deletion docs/commands/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
---
icon: book-open-cover
---

# Command Reference

```{terminal-shell} contree --help
```

```{toctree}
:maxdepth: 1
:caption: Commands

auth
use
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/kill.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: circle-xmark
---

# kill - Cancel operations

:::{note}
Expand Down
Loading
Loading