From bf1dca3bc4b150ca15b0ff6c9fbff433659b6025 Mon Sep 17 00:00:00 2001 From: Olivier Date: Tue, 28 Oct 2025 21:52:04 -0400 Subject: [PATCH] improvements --- .idea/.gitignore | 8 + .idea/Onyx - obsidian cli tool.iml | 14 ++ .../inspectionProfiles/profiles_settings.xml | 6 + .idea/misc.xml | 7 + .idea/modules.xml | 8 + .idea/vcs.xml | 6 + README.md | 188 ++++++++++-------- src/__pycache__/obsidian_cli.cpython-312.pyc | Bin 31830 -> 36658 bytes src/obsidian_cli.py | 103 ++++++++-- test_vault/2025-10-24.md | 0 ..._obsidian_cli.cpython-312-pytest-7.4.3.pyc | Bin 11649 -> 15117 bytes tests/test_obsidian_cli.py | 66 +++++- 12 files changed, 303 insertions(+), 103 deletions(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/Onyx - obsidian cli tool.iml create mode 100644 .idea/inspectionProfiles/profiles_settings.xml create mode 100644 .idea/misc.xml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml delete mode 100644 test_vault/2025-10-24.md diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/Onyx - obsidian cli tool.iml b/.idea/Onyx - obsidian cli tool.iml new file mode 100644 index 0000000..53479fe --- /dev/null +++ b/.idea/Onyx - obsidian cli tool.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..7ea4694 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..b317642 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 5fc84f8..3d8fd0d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Onyx Python Helper +# Onyx CLI - Obsidian Command Line Tool -A Python-based command-line interface tool for interacting with Obsidian vaults. This tool allows you to manage your Obsidian notes directly from the terminal. +A Python-based command-line interface for interacting with Obsidian vaults. Manage notes directly from the terminal without opening Obsidian. ## Installation @@ -10,130 +10,153 @@ A Python-based command-line interface tool for interacting with Obsidian vaults. pip install -r requirements.txt ``` -## Usage - -### Set Default Vault - -First, you need to set up your vault with both its name and path: +## Quick Start +Set up your default vault: ```bash -# Set up a new vault with its path (required for first use) -ob-cli set-default "vault-name" --path "/path/to/vault" - -# Print current default vault and its path -ob-cli print-default - -# Switch to another existing vault (only works for already configured vaults) -ob-cli set-default "another-vault" +ob-cli set-default "my-vault" --path "/path/to/vault" ``` -### Open Notes +Then use any command: +```bash +ob-cli open "note-name" +ob-cli daily +ob-cli frontmatter "note-name" --view --key "tags" +``` + +## Commands + +### Vault Management + +```bash +# Set default vault (required first time) +ob-cli set-default "vault-name" --path "/path/to/vault" + +# Print current default vault +ob-cli print-default +``` + +### Opening Notes ```bash # Open a note in Obsidian -python src/obsidian_cli.py open "note-name" +ob-cli open "note-name" -# Open a note in specific vault -python src/obsidian_cli.py open "note-name" --vault "vault-name" +# Open note from specific vault +ob-cli open "note-name" --vault "vault-name" ``` -### Daily Notes +### Periodic Notes ```bash -# Create and open today's daily note -python src/obsidian_cli.py daily +# Create or open today's daily note +ob-cli daily -# Create daily note in specific vault -python src/obsidian_cli.py daily --vault "vault-name" +# Create or open this week's note +ob-cli weekly + +# Create or open this month's note +ob-cli monthly + +# Create or open this quarter's note +ob-cli quarterly + +# Create or open this year's note +ob-cli yearly ``` -### Create/Update Notes +### Creating & Editing Notes ```bash # Create a new note -python src/obsidian_cli.py create "note-name" +ob-cli create "note-name" -# Create note with content -python src/obsidian_cli.py create "note-name" --content "Your content here" +# Create with content +ob-cli create "note-name" --content "Your content here" -# Create note in specific vault -python src/obsidian_cli.py create "note-name" --vault "vault-name" +# Create in specific vault +ob-cli create "note-name" --vault "vault-name" # Overwrite existing note -python src/obsidian_cli.py create "note-name" --content "New content" --overwrite +ob-cli create "note-name" --content "New content" --overwrite # Append to existing note -python src/obsidian_cli.py create "note-name" --content "Additional content" --append +ob-cli create "note-name" --content "Additional content" --append -# Create and open note -python src/obsidian_cli.py create "note-name" --content "content" --open +# Create and open +ob-cli create "note-name" --content "content" --open ``` -### View Notes +### Viewing Notes ```bash -# Print note contents -python src/obsidian_cli.py print-note "note-name" +# Print note contents to terminal +ob-cli print-note "note-name" -# Print note from specific vault -python src/obsidian_cli.py print-note "note-name" --vault "vault-name" +# Print from specific vault +ob-cli print-note "note-name" --vault "vault-name" ``` -### Move/Rename Notes +### Moving & Deleting Notes ```bash -# Move/rename a note -python src/obsidian_cli.py move "old-path" "new-path" +# Move or rename a note (auto-updates internal links) +ob-cli move "old-path" "new-path" # Move in specific vault -python src/obsidian_cli.py move "old-path" "new-path" --vault "vault-name" +ob-cli move "old-path" "new-path" --vault "vault-name" -# Move and open note -python src/obsidian_cli.py move "old-path" "new-path" --open -``` +# Move and open +ob-cli move "old-path" "new-path" --open -### Delete Notes - -```bash # Delete a note -python src/obsidian_cli.py delete "note-path" +ob-cli delete "note-path" # Delete from specific vault -python src/obsidian_cli.py delete "note-path" --vault "vault-name" +ob-cli delete "note-path" --vault "vault-name" ``` ### Frontmatter Management -```bash -# Edit frontmatter -python src/obsidian_cli.py frontmatter "note-name" --edit --key "tags" --value "project" -python src/obsidian_cli.py frontmatter "note-name" --edit --key "tags" --value "project,urgent" -python src/obsidian_cli.py frontmatter "note-name" --edit --key "status" --value "in-progress" +Edit note metadata in YAML frontmatter: -# View frontmatter -python src/obsidian_cli.py frontmatter "note-name" --view --key "tags" -python src/obsidian_cli.py frontmatter "note-name" --view --key "tags" --value "project" +```bash +# View a frontmatter key +ob-cli frontmatter "note-name" --view --key "tags" + +# Check if a value exists in frontmatter +ob-cli frontmatter "note-name" --view --key "tags" --value "project" + +# Edit frontmatter (add or update key) +ob-cli frontmatter "note-name" --edit --key "tags" --value "project" +ob-cli frontmatter "note-name" --edit --key "tags" --value "project,urgent" +ob-cli frontmatter "note-name" --edit --key "status" --value "in-progress" # Clear frontmatter values -python src/obsidian_cli.py frontmatter "note-name" --clear --key "tags" -python src/obsidian_cli.py frontmatter "note-name" --clear --key "date,status,tags" +ob-cli frontmatter "note-name" --clear --key "tags" +ob-cli frontmatter "note-name" --clear --key "date,status,tags" # Delete frontmatter keys -python src/obsidian_cli.py frontmatter "note-name" --delete --key "tags" -python src/obsidian_cli.py frontmatter "note-name" --delete --key "date,status,tags" +ob-cli frontmatter "note-name" --delete --key "tags" +ob-cli frontmatter "note-name" --delete --key "date,status,tags" +``` + +### Version + +```bash +# Display version +ob-cli --version ``` ## Features -The tool now includes all major features from the original Obsidian CLI tool: -- Set and manage default vault -- Open notes in Obsidian -- Create and manage daily notes -- Create/update notes with content -- Print note contents -- Move/rename notes (with automatic link updates) -- Delete notes -- Complete frontmatter management (edit, view, clear, delete) +- **Vault Management**: Set and switch between multiple Obsidian vaults +- **Note Operations**: Create, open, move, rename, and delete notes +- **Recursive Search**: Find notes in nested directories +- **Periodic Notes**: Support for daily, weekly, monthly, quarterly, and yearly notes +- **Frontmatter Management**: Edit, view, clear, and delete YAML frontmatter +- **Link Updates**: Automatically update internal links when moving notes +- **Cross-Platform**: Works on macOS, Windows, and Linux ## Requirements @@ -145,8 +168,6 @@ The tool now includes all major features from the original Obsidian CLI tool: ### Running Tests -To run the tests: - ```bash # Install test dependencies pip install -r requirements.txt @@ -154,15 +175,16 @@ pip install -r requirements.txt # Run tests python -m pytest -# Run tests with coverage report +# Run with coverage python -m pytest --cov=src tests/ ``` -The test suite includes tests for: -- Vault management -- Note creation and modification -- Frontmatter operations -- Note movement and link updates -- Daily notes -- Platform-specific note opening -- Note deletion +## Configuration + +The CLI stores vault configuration in `~/.onyx-cli/config.yaml`. You can manually edit this file to manage vaults: + +```yaml +default_vault: my-vault +vaults: + my-vault: /path/to/vault + work: /path/to/work/vault diff --git a/src/__pycache__/obsidian_cli.cpython-312.pyc b/src/__pycache__/obsidian_cli.cpython-312.pyc index 7f59befff91904c18c828af8012c3f959b58e497..252f486417b139a6d7cd6d791b3f1b6ba5d3a50f 100644 GIT binary patch delta 10372 zcma($33MCRal5!doFs^YHz=N0+YO(N%L-00e`faoU;H2c?XRe;uUIT;96Xl;d~ko?1*=E(edC4l)ra_yu0tnq0w2d@rNh!=?XdRPI&3}m4m-oqgwlI5Ix=`p#ckyT z?O9IHJ*PrO9M|EXZ)meFyyVe3MQ3*veY-rHE>mgwYWhrugW5M6bt+Eex|gx)YQ937 zl|nnsTeR7!+8oh(y_Hw+|Ddwc|KW4BISa7n`u3_awYi_r_buqlyKCPPZT?-`tyENJ zY70K0@1LR1yP!{*;+(Wqn#`2kmig0uFxBz3RH;#?qZ68K+QL6OBr4#HHdnjkPApsb zbG)(yOu>pUA8F@Qw?KqOU4yphE`wAq7-UYfzt-hyiy1yHW0u}NyP$Kk_3M+f{amW_ z52?~rs`RH+smzcutDpM}9i|dt{aLP~^iG*5@?g`kHQXtkqfyxKyd`OUbGGGZ5;oqg zoq`JaX8ML^d1*(PST1ZjQOk2zRmAqy^T&ADhn_1vi4+OBq|1G zaoEc;Te;n;qPfNzekE-+dgDgU$O)^2G*Ks*;Aa+%qFK~s0WSUo%c8mg>a17L3i>Xy zU_Gntun0C$FK9)ps1t2nDx~Yu2==p@4!f{Y(7>oRQ3oyQfSWF4fZj3~*VVu^t`i)9 zV1Qqy=n$OnbBPWZ*bT^;K#qbzFOYkn#VKS#UCZj(z`z9z;Htg;;V!_sCiPg ze5hrmY6Vcs##)@AdZC(=>MVp>F4X2&FM*akVU17(tcn$OOiY7N0zLVFTbdH03|b1< zq_kq1=mnh=cByA|QVt?70bIS{6TL8{inDP|N0G3Wv04g4RL%}#5UOC9;=A@#Lr=-9 zcu0e@)d@AwT6#z8GH5LmY5_~p*>Vt|T&QD{UIAsFW>D{2H|{a@^SpZeyjjKb_Hkj?X{}pN`nDV+n#{ znw4Id?SZ1K3q-06q=Du}LL@r3f+sNE!fMcoYd8P#bdZ2oDZ4x3*OKkBLz~o0Gq{GkP3( zNVrE%bGOo+kL6#;AJt5G>E|4K`BM6(bbj8MQy z-@c`x)~1{iZPK?K1eFf!hV?OhjDHeh6GnJG}dvo*Y<)a#UwMmm1 z(*c&|sTBQZ_?Us-pW$?91>N)dq-R>m4I5)d`nEljdh?8Y8vVo00<9sI7B$mncIR53 zLs8%vHpNU*78}3Kud~Cr>ZDvSu8Hz1GwEr6TH3HVW*c~Z~iNp4I-vSaE^+@rRD>KGSL9kRj{Z82NSdJ4?`5d)Mor+6q?VzvvaN9-DI z*gk9vF9SMf%sP(_R*TUo*gyx^rdjMP;N)Du1+X_PWHS$46|)Z81*>2Rr4Oe^OOnFJ zR4L75#4=#1Yd7cE95Dw`3AQjV*oQNtWi(urTN%ae!=6}1k|dTXm|?ZkpToTZ4_oc@ z?xm=5w=rgaJ|n5GVQ0)C*<-V*Q8v%T?8-EQs2U8;7jh^qxf_p5krKg2bjJI_CoGoaqj_45H}3#f)|{Q&=5 zY4Hfjkq6Xq9LDDus@Ocx8zE6|rx!P7ndI#vk#Mx9Ga40%HyVNV=Jq{a+@jSVtE+p2 zAzd5bdCP`eWk})eiu8pAZ!qj-e#BcQ^YBlGw0+U8sx>}dHi+RsLo)D!)zsQ5 zYmbpgU$3l{q9oW$QZ86d3rfMT6zvQLL|G#Q15sHM3Q7P^h=Y=>4oIh%GnNfU`+}h; zpvr0(LQdNRsC!8elq#G0@f|-7oJGPsxolufB+~D5D^9!)MP7kmC4yB57P{D3M~Z%1 z=DTD)M3kr)j>_rt*3YlZ$vD{A6Y@vJfv9Xs^~OPx^v+YA!BFSX(45y*gZq`Ovp(1# zjrjW{k=zIDQ{I|!G@(KG#Q~VQBx`yif+*{hIml|5hJ=m_qt0C(7Kmia3X$0zvH+zG zIg>GIK{L)n-n+Zy262 zBz*T=IrdZX^T8JfC%yM4%y~B*#kX8JQ?AkpS82kx^_ubOgNX;)6J@(5UAq(Z-EVn( zQ=Xa$Pt9e1(zAS|Wjb#2By8T%mT&BMX2)dl$}1VK7T3=WP_}N;RiCie-^$K^y87|z zv8>7Lx{-U|apYY*@%)PGj%6>H?!=u@b89#8AGtYe-EZ@`yu#6(slwWc!rIBgy2;!X z2}9ORQ}*NWx2x`%%p17mkBo}w1mMi;W{iLgG z#5C`d(1 zJ?->7cKE{K(WcAQ=MPUhn?|#h|zu*wXDC^<`1WecHi zdVL_Mv9Ol^(s+I04YdjL5>f+TXd|7;aMEQZ)qFqomlSNB%R(PSoRn`~oE{^8pITu! zmk(pA240C|(U(em{CDX4CI4>3#FU^ZjQ^r^MCBxFpty@*QbigOGytFx-vNF(eZ`j* z_hK8HCoa#tgm@!VWv$`|Q8w9#L58h~&pgkuBP+$7e+EkrAvlX5l|YkrtR6 zko2WGEP(uxiW2?Lu+zrV$hs^VZZD?O6(7=YosoZoTAI#Vilav8XHQIn*=tcUDNg1d z$@j1>rX$*zPEdihRF={|?#y?q8S=s$R@;lOP%xS+nBalI42L&cPm%M%}T)jYml3K z9s$$xy-4iHNY7f~Q1?BeKcgM?!vY6_l?f*_^DhPZu=|Etx>Rxqe@{T`8%a>lsvB#ddL+hkZ&qA zfqWlpV+g*gG&Pa0D}_#SSt)EIKg9lTE43E#Pgwg$jw?Z)_mS@^?d?$M^{L2J?0pdc ze1vX-7j3Nd=$KP{k{+rJfIoS$wqB*-$NyNni-%9x_PS!#DlL33R*iqX?hCx_JAyR^ z$2R!sehTEI%`5BG)zM6PK0j9l#)^lZ|FzOdzrWI~u3Fq&$lrmtZB_Q2c$wo*t@;7a z-=O=~tlt_yfdvF2f-VHd0c=r1K{wV_153RKP9k^(fNT&TCPjnrRjv+4`eg$o ztzB3pbK4M&nS23&&p|vaK>RDVEZj#xDMlghJth%?y-Vq1Yj^9|q}u6+Yb#+<3f8sg znjo{6o*fUbtK#ER?(zwD`INhI!d*G(uAXwQo^Y?eqM3BBzo2=?UGT}>=QXz+Ia7|} z2}kjiqkO_qKIy2Ka@0*Y>Mn1ZbgUiOG@YG)(RGoG7LU3T?(%cn?mC(QxtS*2o5ufG zujZ}w+{^V@+db-kaq|Fa(}vA-*ZShZV=$SvOFVf4-j`I08^M`NDgewKKfb<*KTChK zJ_juA47leP8fxgn8=Q1igDc}LKq7B1KtJ42k~accxQ*fLH20RlJY}euFjS1KxxD*^ zp`IiMIe0hXvc@w05xS#sKCkh{+Pk6tZ{yOu^Qi5`eCn@gZx|XcN^d*8%nHS zf&s{X;3P@`&>t<8X`-oBL>nXzBRCJhXHe{J&SIGHIkBJR0xVpk1;Viy+otR*XQBNt zKP>40$;%#4NG!i6baB(R z*T#2leSp`Y(n$OG*tR;J?b|t>4H-6xAu%cn-cQq>tm_NIC+-O*PEvs^OIWBtS;JDm z`5FZ7vPock{Ip|xmj0)x&3@EoHvQ7}BTPO>RlT{H`v$nUBL?yBh%Ja?{>9y86J~96L)*JjDHE`Mj=kFP_d85B86zTU% z(ZP@ib70yw0}4#87afq2%&~M4RS!C0cEYA<0X)Uk?W1KoR)dE9J61xX^W`0X1?G^s zbE|5}LUZ_7Ul}`iAa)S^X0-E|B=ePIJsp0)`ziLpR^Nckwt)!5i6u0F1<8X8Tipm2 zYF|ks_!FcRX;I`m69Zb%Uc>)pd`J7Y)uwq8Q}f>PxD6;}6Pwe|9EK1A%_xbF3Q^bL@P-$>-20@NKaG<0m7iXNdSh~AtmEq|Gn*TR+7b=5)QtF6Q)`auPn< zUowr9dI?;?awMk^VQOx&0S;4waC{|@OrAb{#0_@-y(4w1TGjY_NBq1FY#GjRAS}7! z_#pq;Ft0EZmOvC*H&L_ z|1AeEWu?vZyT`&S>Txy#dv!>O9%(*DvJqPmoTBSb6ac3~Ct{_H3~d2YMMeRVaI<%Bm_iZ+!}L!l z@_-;OG*rw8nB8mz)cKc*?;tvYhv*MNh<@nA9$M2=qL45vTTJqwNP^%T9q37tyw_8v zki3Vzi%EWijR+p4tHX*=C+O9%t$_)~40tige)I77&}Q+K{oTYW5HsT)QPw z#W&LW$SQy&QUjUsS0hhtWrMO$2%Vx;<_wv${|t`$5Q4J+q{aD*E&wO>kRa>?c2ClW zd&@u}XUIOPJ6Tx5MrGSV_b|Qrg?#cOCHg*!wo6~64g+3b0iFN$7`aUu=Tu=qupX4 zs@xALVa1DE(u-juG+5o{?r!j!fuA9kWo{MugV7Vl8$fvotJ-Lt6 zjYL1cHlZmUEe4=?gB8$;#x;9EJXFyf>FMdLl0?Wp!6XDPUch)GUEbMS3zRB}3uLp` z$ag36ETWr54rnnMHh&Q~gK|_PJ*J{BHn`}KB7+&O6IH`nxV21=sgsQ!)~JiBfq*^F z&A#ckR%gazT#S#w;aW`doK|Uvqc0VNXWw6Z_eOF+g%IxuOH7%yb;3|^Ld={Ksz}z) zPFmK_&Vm`CY>p>y*4agsdA8G!HRgI}EkwDO(JA*YL;!v_acP=h=+oQ>cCMoK{OZTn zUsyltxb7&qESzq=>07p_<(9_uP|K7iXF`*6v1RnZ%dJ-{6FYYwyrJ2{R#GutypTH+xiRQ7!wqKzY!amGkyn4%xN+=h(3)u7{zViMrYfV;HE)q zg~J;JD-kS;Xoha3d@{bx7B LrIRL`t=0bn*+Va^ delta 6498 zcma)BeNW{p&{|2|N_K4_9=pU-B`x@6&RUE)ehp!dB8EU4I3EwO=GhkPoFg6RMaRhKdIvXfXB?tNv@8^R4Y#5QJPA?8| z!H^svp@2!rhhA=?R{*`dM6VEfu0*d0dijZ7G4u+cw={JLPzseMr4%N28wPPRtx6ei zil$+3xj_ayD}YqYS0$+_Y6?d?)kZlWD|JAwTt-G}Jy1Q$8t#t|n zo-?Y_U{nbX`6AJns`(7J(ppwt)kIvZzp6ED9gNdLut_t*%?$QvXKnnuRo@oDwX=0) z<%PhUEZ9Y9l)5!F77Ip(-P|8;^v7m5ZD2pC(?}-ktgp{W+DQ;IcBF=#t1s+AAL|yX zYSGYfl{-im)uFpUDKgAjj2hcij&hX#8-~jPyMJHb2zD2*X(ET?d)CaGQ%jKE z05G|O`LlCaTT{buCw9}@)Br}KVee-5q}<0%_S(2|W1G5B`d#A(L&s}2j93a7Gf;WF zu$P;>`RUeiYt^ zz(a07whkZ+AS5DCuQJTVebmKpR8e&j(Cjb<)|U8C7o!_I{j`k4pUUqbyHUHFV|CHmLH=Y(rEbUX`|6e z&m;e%Mz4!LfW5PVP>FN)(EAMfUg(T^P4v^q{S1It)J;@nH@3NC?yV?GYaN0Ua;$ZW z>1iSUU#VI%xf~bhdG^+hEoqf8 z414|=$>r5vX7=nAPU}7#$m0bAzSo;+ z#9cd*dC0Y5>w^eOH^p}B?m(DBz$31kBhhi)3b`qOg-cT4Vu;ZofY)h+=%YM?ERRu; zH1efJcjEY3_W6!|GG9-C{iUN`cHtbwtgo|}wRcuqZb4W3sEIwYAwT}fPA3_S);_lGMd#YHZ9gq2xtM#A z&Q;FkUe2pI*SS*m?icg6#H&AKCJv|Yf-}Est@(vU0?5AKy^GzmyRvK}7}R@-(5K+{ zlF3*oE-`T@vv2IKDBePVg7@5v@H4CZs6x^uJs z2L{ovEK~5YZVzc?U+yl15PhM0Y_%bMJ=MiKSDRzglj^*+WnqqMJx!|#m-g0?4z|13 z(2u6ntv2kAPC`}FbNdZb=JILb-e5ib4g9)D3c@lpD;oh1-_n(#%T&cHh=zcy zOLRCCJz@mX0u z7cS^qSS;UvZvQWUU?ipMtmDu|uz&i{dh!|el|#7U>pt9JDqrrjcP#Z&ciu5|CuF#o ze^}E=J#AqRA9lY_1n}*B6^)W0X9Y*;?{H$=Wp8RyIKGM0-yoD4z@!q%mlIx7}B_*f@BU;QK8B%pI z6a>S2Kns?%<0?(^>RYHg?LC*_HR^f3js<_CD&o`AhQ=ry3asQqV=8@+{XxxzZLkI! z<)<-}iy)MT*j(UQ*pCkn-yj7^D+3ku2Et8*7B(F8bo~*U-jtQbtm01kHVXX-f%_9* z*ev-Iyg46il3zj-URfwiI^)ri9p>Uy3~2AC7?kvNf&DPt{XVgf2vC}c3W_dF@@OIl zc+>x#mEifI*Ad=8X#N{wVtKk13dmp}s4Dcgz|hhGmKMreu-flOnoVzzIEng*iALhh z$Jz)PVkc-<13xVhlr(Wkqm&Cnd#RL56ox762JI{I0Mko)y%NRpptrrf-D~Q_Z?CtS z9o9V4SkzE7gk~UMT=B<1inkTTx>1*6W1}I}h*&F9Z3yiMwZ}rO;`LAVHx%7SDw1nbx{3(CiS!ViMe{NNCibul=P!MJb1}=&>^HEc-fKN{>#k@1ANy?De@c=5q7YL?!j43-F>uYLiN*X&5aMBy|6*t zMjnbQrN4pF2%WH0S_am0-%i@rtXX(ug(P?ErHJn68)ocDfp@e*M${8<{EdaIJV?Xfe7Itb)v8 z1V5)D9E5#z=JAclpW8Jr)*A6(6f8`ixwMIE!2<{Py+KBe+%|5J$ki?=#>ZWF4N(X4 z9cIs*s#qvsz@(8zt_Tk;c#&VWH*>_0#9 zC6X8KyBA)Q>Fobc_tv3ac+oKyPO8~f$pG+jqMvO)lUIY<>597=537bLiYHVANUAeu z@}+ga7-f%~`P{Szr?L8cVSg~<^LZvP zdHC`u#Ax8DlJ5lfC&iUeJHm==Wo>~QW-O#`qbFFze?_ppBBb&^ zw)Q@;XD5Gb&VO07oY{5L KEQkes|NaT)zUO@a diff --git a/src/obsidian_cli.py b/src/obsidian_cli.py index 09c59ed..c6bd553 100644 --- a/src/obsidian_cli.py +++ b/src/obsidian_cli.py @@ -5,7 +5,8 @@ import yaml import json import subprocess import sys -from datetime import datetime +import datetime +import builtins from pathlib import Path import re from typing import List, Union, Optional, Dict, Any @@ -50,6 +51,7 @@ class OnyxCLI: vault_path = self._get_vault_path(vault_name) return vault_name, vault_path + def _get_daily_note_settings(self, vault_path: Path) -> Dict[str, Any]: """ Get daily note settings from Periodic Notes plugin (if enabled), @@ -298,13 +300,13 @@ class OnyxCLI: # Use ISO week number year_format = 'yyyy' if 'yyyy' in settings['format'] else ('YYYY' if 'YYYY' in settings['format'] else 'yy') if year_format == 'yyyy' or year_format == 'YYYY': - year = datetime.now().strftime('%G') # ISO year (4 digits) + year = datetime.datetime.now().strftime('%G') # ISO year (4 digits) else: - year = datetime.now().strftime('%g') # ISO year (2 digits) - week = datetime.now().strftime('%V') # ISO week number + year = datetime.datetime.now().strftime('%g') # ISO year (2 digits) + week = datetime.datetime.now().strftime('%V') # ISO week number filename = f"{year}-W{week}" else: - filename = datetime.now().strftime(date_format) + filename = datetime.datetime.now().strftime(date_format) # Get template content if specified content = "" @@ -443,6 +445,11 @@ class OnyxCLI: if not note_path.suffix: note_path = note_path.with_suffix('.md') + if not note_path.exists(): + matches = list(vault_path.rglob(f"{note_name}.md")) + if matches: + note_path = matches[0] + if not note_path.exists(): raise click.UsageError(f"Note {note_name} does not exist") @@ -468,6 +475,11 @@ class OnyxCLI: if not note_path.suffix: note_path = note_path.with_suffix('.md') + if not note_path.exists(): + matches = list(vault_path.rglob(f"{note_name}.md")) + if matches: + note_path = matches[0] + if not note_path.exists(): raise click.UsageError(f"Note {note_name} does not exist") @@ -495,6 +507,11 @@ class OnyxCLI: if not note_path.suffix: note_path = note_path.with_suffix('.md') + if not note_path.exists(): + matches = list(vault_path.rglob(f"{note_name}.md")) + if matches: + note_path = matches[0] + if not note_path.exists(): raise click.UsageError(f"Note {note_name} does not exist") @@ -513,6 +530,11 @@ class OnyxCLI: if not note_path.suffix: note_path = note_path.with_suffix('.md') + if not note_path.exists(): + matches = list(vault_path.rglob(f"{note_name}.md")) + if matches: + note_path = matches[0] + if not note_path.exists(): raise click.UsageError(f"Note {note_name} does not exist") @@ -558,14 +580,30 @@ class OnyxCLI: @click.group(name='ob-cli') def cli(): - """Onyx CLI - Interact with Obsidian from the command line""" + """Onyx CLI - Interact with Obsidian vaults from the command line + + Manage your Obsidian notes, frontmatter, and periodic notes directly from the terminal. + + EXAMPLES: + ob-cli open "my-note" + ob-cli daily + ob-cli frontmatter "my-note" --view --key "tags" + ob-cli --version + + For more help on a specific command: + ob-cli COMMAND --help + """ pass @cli.command() @click.argument('vault_name') @click.option('--path', help="Path to the vault directory") def set_default(vault_name, path): - """Set the default vault for future operations""" + """Set or switch the default vault + + USAGE: + ob-cli set-default VAULT_NAME --path /path/to/vault + """ # Convert Windows backslashes to forward slashes if needed if path: path = str(Path(path)) @@ -573,20 +611,29 @@ def set_default(vault_name, path): @cli.command() def print_default(): - """Print the current default vault and its path""" + """Display the currently configured default vault and its path""" OnyxCLI().print_default() @cli.command() @click.argument('note_name') @click.option('--vault', help="Vault name (if not using default)") def open(note_name, vault): - """Open a note in Obsidian""" + """Open a note in Obsidian + + Searches for the note in the vault and opens it in Obsidian. Supports nested directories. + + USAGE: + ob-cli open "my-note" + ob-cli open "folder/my-note" + """ OnyxCLI().open_note(note_name, vault) @cli.command() @click.option('--vault', help="Vault name (if not using default)") def daily(vault): - """Create or open today's daily note""" + """Create or open today's daily note + + Uses Obsidian's daily notes plugin settings (format, folder, template) if configured.""" OnyxCLI().daily_note(vault) @cli.command() @@ -621,14 +668,19 @@ def yearly(vault): @click.option('--append', is_flag=True, help="Append to existing note") @click.option('--open', 'open_after', is_flag=True, help="Open note after creation") def create(note_name, content, vault, overwrite, append, open_after): - """Create a new note in the vault""" + """Create or modify a note in the vault + + USAGE: + ob-cli create "my-note" + ob-cli create "my-note" --content "Some content" --open + """ OnyxCLI().create_note(note_name, content, vault, overwrite, append, open_after) @cli.command() @click.argument('note_name') @click.option('--vault', help="Vault name (if not using default)") def print_note(note_name, vault): - """Print the contents of a note""" + """Display the full contents of a note in the terminal""" OnyxCLI().print_note(note_name, vault) @cli.command() @@ -637,14 +689,21 @@ def print_note(note_name, vault): @click.option('--vault', help="Vault name (if not using default)") @click.option('--open', 'open_after', is_flag=True, help="Open note after moving") def move(current_path, new_path, vault, open_after): - """Move/rename a note and update all internal links""" + """Move or rename a note and auto-update internal links + + Automatically updates all [[links]] pointing to this note in other vault files. + + USAGE: + ob-cli move "old-name" "new-name" + ob-cli move "old-folder/note" "new-folder/note" + """ OnyxCLI().move_note(current_path, new_path, vault, open_after) @cli.command() @click.argument('note_path') @click.option('--vault', help="Vault name (if not using default)") def delete(note_path, vault): - """Delete a note""" + """Permanently delete a note from the vault""" OnyxCLI().delete_note(note_path, vault) @cli.command(name='frontmatter') @@ -657,7 +716,15 @@ def delete(note_path, vault): @click.option('--value', help="Value to set or check for") @click.option('--vault', help="Vault name (if not using default)") def frontmatter_command(note_name, edit, view, clear, delete, key, value, vault): - """Manage note frontmatter""" + """Manage YAML frontmatter in notes + + Must specify exactly one action: --edit, --view, --clear, or --delete + + USAGE: + ob-cli frontmatter "my-note" --view --key "tags" + ob-cli frontmatter "my-note" --edit --key "tags" --value "project,work" + ob-cli frontmatter "my-note" --delete --key "date" + """ cli = OnyxCLI() if sum([edit, view, clear, delete]) != 1: raise click.UsageError("Exactly one of --edit, --view, --clear, or --delete must be specified") @@ -671,5 +738,11 @@ def frontmatter_command(note_name, edit, view, clear, delete, key, value, vault) elif delete: cli.frontmatter_delete(note_name, key, vault) +@cli.command() +@click.version_option(version='0.0.1', prog_name='onyx') +def version(): + """Display version information""" + pass + if __name__ == '__main__': cli() diff --git a/test_vault/2025-10-24.md b/test_vault/2025-10-24.md deleted file mode 100644 index e69de29..0000000 diff --git a/tests/__pycache__/test_obsidian_cli.cpython-312-pytest-7.4.3.pyc b/tests/__pycache__/test_obsidian_cli.cpython-312-pytest-7.4.3.pyc index 251a4140dee2e5eb36a04274b4497d34187dd50c..319457ca3ac1f69a9057acd4bf0343d89c7da35d 100644 GIT binary patch delta 4481 zcmb^!TWlN0@t)+7JdzSgQ7=-YUX&PuZ$QvdChbM>B6e*ZVnMxvntQMnPQL;&qn zEOANVMS0*$nRrqR0KpXTRKfWmA=aQ}!)RIhd9QYC6cTIcnX7IV``;-?>fw0$2 zT)_a|vxJ#$vj2yFQ(${*h^W-cEmaHD|<9Zjk;4)LQ*hD!v zTIY09ocS8E1pIJ}v!Fj!3HD)>;H;c&oLIE$g8tu1lxK;N1-~CzykS%n# zqPW%VUHX+h@ZNszXdpO0Sa;VWquJ`YhE3{1OS{3pShukeh15hn=(eaO^pFDRJyo^73!NUz*(%M4r(Q;__d0YH9UbOj#2;o^ znHS_ND?{OGuIx;4SxY)2PiEwB=csf}G2L4Vk_s&+QOB}fV`X6cMP*0BSXBwiRzbMQ>rh`K$bZ4RNmX7$uam(V8tLnY0Jb!{T5HWWOw z1m$bzL6Z6DEs}NeC?XG1;!YTVVjlvJA+T2;!eX!s;rk%ShBUp9LLrUwCcR3!gjDM( ztdPzLF@8EBskSp~)hg&nWUU87t*m!enbXlpMdVrjj!0Y5@cP& z=`D^|`DI;vYEqur;B-I@3B<~de2M=1HCHO-o9R@tZ217%x|ydKhQ|gzTfIZcl#YnS6IJ!qj)ifY}_SvprDYCV9^k z*=KY5*=&wgYhA%w_gZGv*H!R!6|LP%$P%v{x^!rjZ78q}ukT*kRb=tr& zDx~x6#-;Jq-oZle;7a6BzUoks8M;qMG~a{fA1LLELVDj}i|har(pox7`=Ye8eKmTZ z5IwNcHIT0wC^83OD6KM81*YmX@J;)z9FN05C|G+wyKB=ChmM$`Sqj$f&+fAKAuc$R zhfC7aFrwdU4j-*0f7KK|+DiT!;yvVV9`}wA|GdKuU2K0;OzIzKii(LRNE#mH>i?str-m(qs}YwE|o9Hd=fVPJyB7 z?RX7%soGU3?m#4#(PU!uY>XGhv?v}!6hEnM#%saN>LGmgdZ5Nm<6+S2d&;1;7!mMw zpXV`@uGBQ6W+7Fm!f4&bkf8SfY%(F7)l*NY4fxpCg})0N{-0{yi$4k9Gz*x#@v_10 z^+@M&4xhy*2oSFK)X7FDQT@1kFMs&Hgq^}HF~L9*A9$1K0=fDM+y>^GoEA!bF_Zf9 zo+Kxn>Ql$*aN#8Qi1C2>hW?!SUg6o6Ek~sZb#~Q|hTsAQGltUx+UJaGt=r~|TBsM9=9^YW-We!bTdwY03wF;9 zy>jHzks=!aryHNQp|0o$q5W;-FWcz-(d&O`JVW?VVN&Z9!i1)^>2QFh;#W?zQ~SUztOUbFlg!ldt2o} zE%=bSswM9Qpkm?pB(FE2lZfCj0{1S;*48=M7RCP#UT^yu43m@X%_H!=jERj1bRy7; zz%vLW5s(nbB7hDheg%P-A$SWDQHQKnND=jX2ZTAr=c(g2zK=4C)=P2XBV<52|NH7erxTWtRKnux R$V*3Ferlb>s2Y{)zX7xVr3C;0 delta 1926 zcmaJ?OKcNY6n$^(8IL_0QuWsYU-mu&`llbWbWtP zckl7Jo)0fwJMH_$>-8Y|Y5w!?$;q8JeIfklW^2yJp~Fb!myjxG!i6SSZ3xsjSQMY3I;11A+_*Ch~j$i zyAI%R;kc`YYYeiKN(NO7*fC2|3_~O4!Hcs>mNdf+cTc#Q`ePiaVPRoBr%znpD!D}r-!z3em4k~74J_txs7@Ga zkHVQ?5c6=m?;7(4uqrIG;`D=&>SBMT6BRV3iuc^hTcl%TmxhgCHGI}5z{AcuP8D9s zrkviB{wKRlmACI&a79r!C2Nku=oGyhqZ_y99jDM7j(Opd)DA|d!IzgtwYdo8z|?ee z6ut@_O?n8U(UQiArkGk<&zV}0Nl%f<6J%Di1Z_TJmus<9VC{XiY;lXrU8#P-Lcye@`T#n7if!cRkfqji!%$Qj%7ORdSdP6O#zfW^(Ac zITEm^qpVJ_B1MsTR3(#L*w$E)2b+I3_<9pAWu@)hnmk@O*gM2s*>29K=X84u>E=?xM`OjsEo$G^(@S|-lB#93 z(lWor=Idwhazp;}yGkQgnJw;DPUXWVsN9czGEj}bgV4Ya*bBc7G+(J>Wf~c<^(K25 zyvZQVKx4p$Cpv?R6z(DtX3w<@#1gQVlW~&5658a-`D1vq#mVo-o3e{Pi8m{%dCz9g zUOu+DpY!vH%|;L3`!s|EX$7timd926%z=bD20J#KWjwW;WIkEEhh1Tb>GZUc(bMTz z75p@KPOx`A0