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.

Sign up for GitHub

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

Jump to bottom

Update README.md #30

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README.md #30

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53a2558
Update README.md
TanayKarve Oct 2, 2020
0605e23
Update README.md
TanayKarve Oct 2, 2020
aaa9da8
Update README.md
TanayKarve Nov 20, 2020
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ ColabCode also has a command-line script. So you can just run `colabcode` from c
`colabcode -h` will give the following:

```
usage: colabcode [-h] --port PORT [--password PASSWORD] [--mount_drive]
usage: colabcode [-h] --port PORT [--password PASSWORD] [--mount_drive] [--option OPTION]

ColabCode: Run VS Code On Colab / Kaggle Notebooks

Expand All @@ -33,6 +33,7 @@ required arguments:
optional arguments:
--password PASSWORD password to protect your code-server from unauthorized access
--mount_drive if you use --mount_drive, your google drive will be mounted
--option choose between "localtunnel" and "ngrok" for tunneling services
```

Else, you can do the following:
Expand All @@ -50,8 +51,9 @@ $ ColabCode()
# - port: the port you want to run code-server on, default 10000
# - password: password to protect your code server from being accessed by someone else. Note that there is no password by default!
# - mount_drive: True or False to mount your Google Drive
# - option: "localtunnel" or "ngrok" to use respective tunneling services

$ ColabCode(port=10000, password="abhishek", mount_drive=True)
$ ColabCode(port=10000, password="abhishek", mount_drive=True, option="localtunnel")
```
## How to use it?
Colab starter notebook: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/abhishekkrthakur/colabcode/blob/master/colab_starter.ipynb)
Expand Down