Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document development tips #3782

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
23 changes: 23 additions & 0 deletions docs/Development-Tips.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Below is a collection of development tips when running CodaLab locally.

epicfaace marked this conversation as resolved.
Show resolved Hide resolved
epicfaace marked this conversation as resolved.
Show resolved Hide resolved
# setting up local instance (-bd is sane default (build, dev mode))
python codalab_service.py start -bd
username codalab
password codalab

# list docker containers running
docker ps (`docker ps -a` shows all dead containers as well)
# check logs of docker container
docker logs codalab_worker_1
# run commands in container
docker exec -it codalab_worker_1 /bin/bash

# connect to prod instance from the CLI
cl work https://worksheets.codalab.org::

# connect to local instance from the CLI
cl work localhost::

# if you're making changes to the CLI and want to test them out real time,
# in order to use the current directory's changes as the "cl" executable
pip install -e .
Loading