All shell scripts in bin/ directory use Windows CRLF line endings causing execution failures on Linux

[eilokevin]

Description

All shell scripts in the bin/ directory are saved with Windows CRLF line endings (\r\n), which causes execution failures on Linux systems. This affects all users trying to use the jacinle command-line tools.

Error Symptoms

When running any jacinle command (e.g., jac-run, jac-crun), users encounter errors like:

• /bin/bash: $'\r': command not found
• _jac-init.sh: No such file or directory (due to path corruption)
• syntax error: unexpected end of file

Root Cause

The shell scripts contain Windows-style line endings (CRLF) instead of Unix-style (LF), causing bash to interpret the carriage return character (\r) as part of commands.

Temporary Workaround

Users must manually convert all scripts:

find /path/to/jacinle/bin -name "*.sh" -o -name "jac-*" | xargs dos2unix

Proposed Solution

1. Convert all shell scripts to use Unix line endings (LF) in the repository
2. Add .gitattributes file to enforce proper line ending handling:

   *.sh text eol=lf
   jac-* text eol=lf
   

3. Consider adding a CI check to prevent CRLF line endings in shell scripts

Impact

This issue affects every Linux user and significantly impacts the user experience, as the tools fail immediately upon installation without any clear error message indicating the root cause.

Environment

• OS: Linux (Ubuntu, CentOS, etc.)
• jacinle version: [current version]
• Installation method: git clone

[vacancy]

Thanks for your message. I actually do NOT think those files were line-ending with CRLF...

$ xxd _jac-init.sh
00000000: 2321 202f 6269 6e2f 6261 7368 0a23 0a23  #! /bin/bash.#.#
00000010: 205f 6a61 632d 696e 6974 2e73 680a 2320   _jac-init.sh.#
00000020: 436f 7079 7269 6768 7420 2843 2920 3230  Copyright (C) 20
00000030: 3139 204a 6961 7975 616e 204d 616f 203c  19 Jiayuan Mao <
00000040: 6d61 6f6a 6961 7975 616e 4067 6d61 696c  maojiayuan@gmail
00000050: 2e63 6f6d 3e0a 230a 2320 4469 7374 7269  .com>.#.# Distri
00000060: 6275 7465 6420 756e 6465 7220 7465 726d  buted under term
00000070: 7320 6f66 2074 6865 204d 4954 206c 6963  s of the MIT lic
00000080: 656e 7365 2e0a 230a 0a4a 4143 524f 4f54  ense..#..JACROOT
00000090: 3d24 310a 0a65 7870 6f72 7420 5059 5448  =$1..export PYTH
000000a0: 4f4e 5041 5448 3d24 4a41 4352 4f4f 543a  ONPATH=$JACROOT:
000000b0: 2e2f 3a24 5059 5448 4f4e 5041 5448 0a66  ./:$PYTHONPATH.f
000000c0: 6e61 6d65 3d60 4a41 435f 494d 504f 5254  name=`JAC_IMPORT
000000d0: 5f41 4c4c 3d46 414c 5345 2070 7974 686f  _ALL=FALSE pytho
000000e0: 6e33 2024 4a41 4352 4f4f 542f 6269 6e2f  n3 $JACROOT/bin/
000000f0: 5f6a 6163 2d69 6e69 742d 6765 6e2e 7079  _jac-init-gen.py
00000100: 600a 736f 7572 6365 2024 666e 616d 650a  `.source $fname.
00000110: 726d 202d 6620 2466 6e61 6d65 0a0a       rm -f $fname..

I just downloaded one of the files and confirmed this.

Can you check if this is a bug with your particular git source downloader? (e.g., if you were downloading these files with some software on Windows?)

[eilokevin]

Thanks for the quick check and for confirming that the repository itself is clean.
After your message I realised that I had first downloaded the archive on Windows and then copied it into my Ubuntu VM – that step obviously introduced the CRLF endings.
Sorry for the noise and thank you again for the helpful response!
Best regards.