ThongCoder commited on
Commit
3dc78fb
·
verified ·
1 Parent(s): 3ea249e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +126 -35
README.md CHANGED
@@ -13,59 +13,150 @@ short_description: An online VS Code on the Web, now equipped with toolchains.
13
 
14
  This Space runs **VS Code on the Web** with a **full developer toolchain**, ready for mega collaboration:
15
 
16
- ### 🔧 Installed Developer Tools
17
-
18
- - **Python 3.12**: pip, virtualenv, JupyterLab, `black`, `flake8`, `mypy`, IPython
19
- - **C/C++**: gcc, g++, clang, lld, cmake, ninja, valgrind, gdb
20
- - **Rust**: stable toolchain via rustup
21
- - **Go**: latest stable
22
- - **Java**: OpenJDK 17
23
- - **C#/.NET**: .NET SDK 8.0
24
- - **Node.js 20**: npm, yarn, pnpm, TypeScript, ts-node, nodemon
25
- - **CLI Productivity Tools**: git, git-lfs, htop, fzf, ripgrep, silversearcher-ag, rsync, sqlite3, tree, jq, net-tools
 
 
 
 
 
 
 
 
 
 
 
 
26
 
27
  ---
28
 
29
- ### 🔒 Security Hardening
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
31
- - **Bash history is disabled globally**:
32
- All interactive shells inside this container are launched with:
33
- - `HISTFILE` unset
34
- - `HISTSIZE=0`, `HISTFILESIZE=0`
35
- - `.bash_history` linked to `/dev/null`
36
 
37
- 👉 This ensures **no command history is ever logged to disk**, protecting sensitive tokens and commands.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
 
39
  ---
40
 
41
- ### 🗂️ Auto Backup
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
 
43
- Every 45 minutes, `/workspace` is automatically uploaded to your Hugging Face repo defined in environment variables:
44
 
45
- - `BACKUP_REPO` target repo (e.g., `username/my-backup`)
46
- - `HF_TOKEN` → your Hugging Face API token
 
 
 
47
 
48
- > ⚠️ On first launch, the backup service will attempt to restore `/workspace` from your `BACKUP_REPO`. Make sure the repo exists. If empty, a fresh workspace will be created.
49
 
50
- Backups are uploaded with a **cache-safe method** to avoid LFS errors.
 
51
 
52
- ---
53
 
54
- ### 🚀 Usage
55
 
56
- 1. Set secrets in **Space Settings**:
57
- - `BACKUP_REPO`
58
- - `HF_TOKEN`
 
 
59
 
60
- **Notes**:
61
- - Leaving either secret empty will **disable Auto Backup** and restore.
62
- - All files are wiped on Space restart. Using either persistent storage space or the Auto Backup Service is highly recommended.
63
 
64
- 2. Launch the Space → Access VS Code at `http://<space-url>`
65
- - No authentication by default (`--auth none`).
66
- - Optional: enable a password via environment variables if desired.
67
 
68
- 3. Work normally backups run in the background every 45 minutes.
69
 
70
  ---
71
 
 
13
 
14
  This Space runs **VS Code on the Web** with a **full developer toolchain**, ready for mega collaboration:
15
 
16
+ # Checklist
17
+
18
+ ## Compilers / Runtimes (Installed)
19
+ - Python (3.12.11 64-bit, pip 25.2)
20
+ - C (gcc) (11.4.0)
21
+ - C++ (g++) ✔ (11.4.0)
22
+ - Clang (14.0.0)
23
+ - Fortran (11.4.0)
24
+ - Rust (rustc 1.89.0, cargo 1.89.0)
25
+ - Go (1.23.0)
26
+ - Java ✔ (OpenJDK 17.0.16, javac 17.0.16)
27
+ - .NET / C# ✔ (dotnet SDK 8.0.413)
28
+ - Node.js ✔ (v20.19.5, npm 10.8.2)
29
+ - Yarn ✔ (global, latest)
30
+ - pnpm ✔ (global, latest)
31
+
32
+ ## Compilers (Planned)
33
+ - Haskell ✖ (ghc + cabal)
34
+ - Julia ✖
35
+ - Scala ✖ (scala + sbt)
36
+ - PHP ✖ (php + composer)
37
+ - Ruby ✖
38
 
39
  ---
40
 
41
+ ## Build Tools
42
+ - GNU Make ✔ (4.3)
43
+ - CMake ✔ (3.22.1)
44
+ - Ninja ✔ (1.10.1)
45
+ - pkg-config ✔
46
+ - LLVM toolchain ✔ (llvm, clang, lld, lldb)
47
+ - Valgrind ✔
48
+ - GDB ✔
49
+ - Strace ✔
50
+ - Ltrace ✔
51
+
52
+ ## Build Tools (Planned)
53
+ - pigz ✖
54
+ - lcov ✖
55
+ - zlib1g-dev ✖
56
+ - libssl-dev ✖
57
+ - libffi-dev ✖
58
+ - autoconf ✖
59
+ - automake ✖
60
+ - libtool ✖
61
+ - m4 ✖
62
+ - nasm ✖
63
+ - yasm ✖
64
+ - graphviz ✖
65
+ - doxygen ✖
66
 
67
+ ---
 
 
 
 
68
 
69
+ ## Dev/Utility Tools
70
+ - Git ✔
71
+ - Git LFS ✔
72
+ - Git Extras ✔
73
+ - curl ✔
74
+ - wget ✔
75
+ - unzip ✔
76
+ - rsync ✔
77
+ - sqlite3 ✔
78
+ - jq ✔
79
+ - htop ✔
80
+ - fzf ✔
81
+ - Silver Searcher (ag) ✔
82
+ - ripgrep (rg) ✔
83
+ - tree ✔
84
+ - net-tools ✔
85
+ - iputils-ping ✔
86
+
87
+ ## Debug + Productivity
88
+ - tmux ✖
89
+ - screen ✖
90
+ - neovim ✖
91
+ - httpie ✖
92
+ - shellcheck ✖
93
+ - man-db ✖
94
+ - manpages-dev ✖
95
 
96
  ---
97
 
98
+ ## Code Tools (npm + pip)
99
+ ### npm
100
+ - typescript ✔
101
+ - ts-node ✔
102
+ - nodemon ✔
103
+
104
+ ### pip
105
+ - black ✔
106
+ - flake8 ✔
107
+ - mypy ✔
108
+ - jupyterlab ✔
109
+ - ipython ✔
110
+ - notebook ✔
111
+ - huggingface_hub ✔
112
+ - hf_transfer ✔ (with env activated for high-speed upload)
113
+
114
+ ## pip Packages (Planned)
115
+ - numpy ✖
116
+ - scipy ✖
117
+ - pandas ✖
118
+ - matplotlib ✖
119
+ - seaborn ✖
120
+ - scikit-learn ✖
121
+ - jupyter ✖
122
+ - torch ✖
123
+ - torchvision ✖
124
+ - torchaudio ✖
125
+ - tensorflow ✖
126
+ - keras ✖
127
+ - datasets ✖
128
+ - transformers ✖
129
+ - accelerate ✖
130
 
131
+ ---
132
 
133
+ ## Database Clients (Planned)
134
+ - mysql-client
135
+ - postgresql-client ✖
136
+ - redis-tools ✖
137
+ - mongodb-clients ✖
138
 
139
+ ---
140
 
141
+ ## Extra Features (WIP)
142
+ - Global npm install directory: `~/npm_pkg_glob` (to avoid sudo & path issues)
143
 
 
144
 
145
+ ### 🔒 Security Hardening
146
 
147
+ - **Bash history is disabled globally**:
148
+ All interactive shells inside this container are launched with:
149
+ - `HISTFILE` unset
150
+ - `HISTSIZE=0`, `HISTFILESIZE=0`
151
+ - `.bash_history` linked to `/dev/null`
152
 
153
+ 👉 This ensures **no command history is ever logged to disk**, protecting sensitive tokens and commands.
 
 
154
 
155
+ ---
156
+
157
+ ### 🗂️ Auto Backup
158
 
159
+ This feature is still WIP. Stay tuned!
160
 
161
  ---
162