Justadudeinspace commited on
Commit
37f53d8
Β·
1 Parent(s): 2c5ae19

Update Clarity Agent README & Add Backtick Codeblocks

Browse files
Files changed (1) hide show
  1. README.md +161 -58
README.md CHANGED
@@ -248,11 +248,11 @@ Light > Denial
248
  ---
249
 
250
  ## πŸš€ Installation
251
-
252
  git clone https://github.com/Outer-Void/blux-ca.git
253
  cd blux-ca
254
  pip install -r requirements.txt
255
-
256
 
257
  ---
258
 
@@ -261,25 +261,34 @@ pip install -r requirements.txt
261
  CLI
262
 
263
  # Run a single reasoning task
 
264
  python ca.py reflect "I feel lost today"
 
265
 
266
  # REPL
 
267
  python ca.py repl
 
268
 
269
  # Evaluate code
 
270
  python ca.py code-eval --file utils.py
 
271
 
272
  # Batch tasks
 
273
  python ca.py --batch tasks.txt
 
274
 
275
  # Export audit logs
 
276
  python ca.py audit-export
277
-
278
 
279
  ---
280
 
281
  ## Python Integration Example
282
-
283
  from blux_ca.core.heart import ConsciousHeart
284
  from blux_ca.core.clarity_engine import ClarityEngine
285
 
@@ -292,63 +301,157 @@ result = heart.process(
292
  )
293
 
294
  print(result.message)
295
-
296
 
297
  ---
298
 
299
  ## πŸ“¦ Project Structure (Updated & Accurate)
300
-
301
- blux-ca/
302
- β”‚
303
- β”œβ”€β”€ ca/ # CLI entry + core interface
304
- β”‚ β”œβ”€β”€ ca.py # Main Typer CLI
305
- β”‚ └── core/
306
- β”‚ β”œβ”€β”€ clarity_engine.py
307
- β”‚ β”œβ”€β”€ heart.py
308
- β”‚ β”œβ”€β”€ perception.py
309
- β”‚ β”œβ”€β”€ discernment.py
310
- β”‚ β”œβ”€β”€ constitution.py
311
- β”‚ β”œβ”€β”€ koans.py
312
- β”‚ β”œβ”€β”€ memory.py
313
- β”‚ β”œβ”€β”€ audit.py
314
- β”‚ β”œβ”€β”€ code_context.py # NEW
315
- β”‚ β”œβ”€β”€ code_tasks.py # NEW
316
- β”‚ └── diff_engine.py # NEW
317
- β”‚
318
- β”œβ”€β”€ blux/ # Integrated BLUX-Lite components
319
- β”‚ β”œβ”€β”€ evaluator/
320
- β”‚ β”‚ β”œβ”€β”€ python.py
321
- β”‚ β”‚ β”œβ”€β”€ js_ts.py
322
- β”‚ β”‚ β”œβ”€β”€ bash_evaluator.py
323
- β”‚ β”‚ └── advanced/...
324
- β”‚ β”œβ”€β”€ orchestrator/
325
- β”‚ β”‚ β”œβ”€β”€ controller.py
326
- β”‚ β”‚ β”œβ”€β”€ registry.py
327
- β”‚ β”‚ β”œβ”€β”€ router.py
328
- β”‚ β”‚ └── secure/
329
- β”‚ └── logs.py
330
- β”‚
331
- β”œβ”€β”€ adaptors/
332
- β”‚ β”œβ”€β”€ bq_cli.py
333
- β”‚ β”œβ”€β”€ http.py
334
- β”‚ └── dummy.py
335
- β”‚
336
- β”œβ”€β”€ reflections/
337
- β”‚ └── *.txt
338
- β”‚
339
- β”œβ”€β”€ scripts/
340
- β”‚ β”œβ”€β”€ ingest_reflections.py
341
- β”‚ β”œβ”€β”€ export_audit.py
342
- β”‚ └── filetree_gen.py
343
- β”‚
344
- β”œβ”€β”€ tests/
345
- β”‚ β”œβ”€β”€ test_evaluators.py
346
- β”‚ β”œβ”€β”€ test_sandbox.py
347
- β”‚ β”œβ”€β”€ test_heart.py
348
- β”‚ └── test_clarity_engine.py
349
- β”‚
350
- └── README.md
351
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
352
 
353
  ---
354
 
@@ -401,4 +504,4 @@ BLUX-Quantum CLI tooling
401
  MkDocs documentation site
402
 
403
 
404
- This completes the unified BLUX-cA kernel.
 
248
  ---
249
 
250
  ## πŸš€ Installation
251
+ ```
252
  git clone https://github.com/Outer-Void/blux-ca.git
253
  cd blux-ca
254
  pip install -r requirements.txt
255
+ ```
256
 
257
  ---
258
 
 
261
  CLI
262
 
263
  # Run a single reasoning task
264
+ ```
265
  python ca.py reflect "I feel lost today"
266
+ ```
267
 
268
  # REPL
269
+ ```
270
  python ca.py repl
271
+ ```
272
 
273
  # Evaluate code
274
+ ```
275
  python ca.py code-eval --file utils.py
276
+ ```
277
 
278
  # Batch tasks
279
+ ```
280
  python ca.py --batch tasks.txt
281
+ ```
282
 
283
  # Export audit logs
284
+ ```
285
  python ca.py audit-export
286
+ ```
287
 
288
  ---
289
 
290
  ## Python Integration Example
291
+ ```
292
  from blux_ca.core.heart import ConsciousHeart
293
  from blux_ca.core.clarity_engine import ClarityEngine
294
 
 
301
  )
302
 
303
  print(result.message)
304
+ ```
305
 
306
  ---
307
 
308
  ## πŸ“¦ Project Structure (Updated & Accurate)
309
+ ```
310
+ blux-ca
311
+ β”œβ”€β”€ CLARITY_AGENT_SPEC.md
312
+ β”œβ”€β”€ LICENSE
313
+ β”œβ”€β”€ README.md
314
+ β”œβ”€β”€ ca
315
+ β”‚Β Β  β”œβ”€β”€ __init__.py
316
+ β”‚Β Β  β”œβ”€β”€ adaptors
317
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
318
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ bq_cli.py
319
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ doctrine.py
320
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ dummy_local.py
321
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ guard.py
322
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ http_api.py
323
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ lite.py
324
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ quantum.py
325
+ β”‚Β Β  β”‚Β Β  └── reg.py
326
+ β”‚Β Β  β”œβ”€β”€ agent
327
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
328
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ advanced
329
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
330
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ adaptive_memory.py
331
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ monitoring.py
332
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ multi_agent.py
333
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  └── reasoning.py
334
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ audit.py
335
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ constitution.py
336
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ core_agent.py
337
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ discernment.py
338
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ memory.py
339
+ β”‚Β Β  β”‚Β Β  └── utils.py
340
+ β”‚Β Β  β”œβ”€β”€ api
341
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
342
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ schemas.py
343
+ β”‚Β Β  β”‚Β Β  └── service.py
344
+ β”‚Β Β  β”œβ”€β”€ cli.py
345
+ β”‚Β Β  β”œβ”€β”€ config.py
346
+ β”‚Β Β  β”œβ”€β”€ core
347
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
348
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ audit.py
349
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ clarity_engine.py
350
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ code_context.py
351
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ code_tasks.py
352
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ compass
353
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
354
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  └── intent.py
355
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ constitution.py
356
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ diff_engine.py
357
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ dimensions.py
358
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ discernment.py
359
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ enums.py
360
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ heart.py
361
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ intervention.py
362
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ koan.py
363
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ llm_adapter.py
364
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ memory.py
365
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ perception.py
366
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ reflection.py
367
+ β”‚Β Β  β”‚Β Β  └── states.py
368
+ β”‚Β Β  β”œβ”€β”€ evaluator
369
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
370
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ advanced
371
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
372
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ bash_evaluator.py
373
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ js_ts_async.py
374
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ pipeline.py
375
+ β”‚Β Β  β”‚Β Β  β”‚Β Β  └── python_async.py
376
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ js_ts.py
377
+ β”‚Β Β  β”‚Β Β  └── python.py
378
+ β”‚Β Β  β”œβ”€β”€ orchestrator
379
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
380
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ config.yaml
381
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ controller.py
382
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ logs.py
383
+ β”‚Β Β  β”‚Β Β  β”œοΏ½οΏ½οΏ½β”€ registry.py
384
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ router.py
385
+ β”‚Β Β  β”‚Β Β  └── secure
386
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
387
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ audit.py
388
+ β”‚Β Β  β”‚Β Β  β”œβ”€β”€ auth.py
389
+ β”‚Β Β  β”‚Β Β  └── secure_controller.py
390
+ β”‚Β Β  └── telemetry.py
391
+ β”œβ”€β”€ ca.py
392
+ β”œβ”€β”€ constitution
393
+ β”‚Β Β  └── behavior.md
394
+ β”œβ”€β”€ docs
395
+ β”‚Β Β  β”œβ”€β”€ ARCHITECTURE.md
396
+ β”‚Β Β  β”œβ”€β”€ CONFIGURATION.md
397
+ β”‚Β Β  β”œβ”€β”€ CONSTITUTION.md
398
+ β”‚Β Β  β”œβ”€β”€ DISCERNMENT.md
399
+ β”‚Β Β  β”œβ”€β”€ ETHICS_ENGINE.md
400
+ β”‚Β Β  β”œβ”€β”€ INSTALL.md
401
+ β”‚Β Β  β”œβ”€β”€ INTEGRATIONS.md
402
+ β”‚Β Β  β”œβ”€β”€ INTERVENTIONS.md
403
+ β”‚Β Β  β”œβ”€β”€ OPERATIONS.md
404
+ β”‚Β Β  β”œβ”€β”€ PRIVACY.md
405
+ β”‚Β Β  β”œβ”€β”€ ROADMAP.md
406
+ β”‚Β Β  β”œβ”€β”€ SECURITY.md
407
+ β”‚Β Β  β”œβ”€β”€ TROUBLESHOOTING.md
408
+ β”‚Β Β  β”œβ”€β”€ VISION.md
409
+ β”‚Β Β  └── index.md
410
+ β”œβ”€β”€ ethos
411
+ β”‚Β Β  └── manifest.yaml
412
+ β”œβ”€β”€ identity
413
+ β”‚Β Β  └── seed.json
414
+ β”œβ”€β”€ mkdocs.yml
415
+ β”œβ”€β”€ pyproject.toml
416
+ β”œβ”€β”€ requirements.txt
417
+ β”œβ”€β”€ scripts
418
+ β”‚Β Β  β”œβ”€β”€ batch_task.py
419
+ β”‚Β Β  β”œβ”€β”€ export_audit_json.py
420
+ β”‚Β Β  β”œβ”€β”€ gen_filetree.py
421
+ β”‚Β Β  β”œβ”€β”€ ingest_reflection.py
422
+ β”‚Β Β  β”œβ”€β”€ interactive_repl.py
423
+ β”‚Β Β  β”œβ”€β”€ memory_query.py
424
+ β”‚Β Β  β”œβ”€β”€ new_entry.py
425
+ β”‚Β Β  β”œβ”€β”€ reflection.py
426
+ β”‚Β Β  β”œβ”€β”€ run_reflection_test.py
427
+ β”‚Β Β  β”œβ”€β”€ update_readme_filetree.py
428
+ β”‚Β Β  └── validate_constitution.py
429
+ └── tests
430
+ β”œβ”€β”€ ca
431
+ β”‚Β Β  β”œβ”€β”€ test_audit.py
432
+ β”‚Β Β  β”œβ”€β”€ test_bq_cli.py
433
+ β”‚Β Β  β”œβ”€β”€ test_compass.py
434
+ β”‚Β Β  β”œβ”€β”€ test_constitution.py
435
+ β”‚Β Β  β”œβ”€β”€ test_discernment.py
436
+ β”‚Β Β  β”œβ”€β”€ test_heart.py
437
+ β”‚Β Β  β”œβ”€β”€ test_interventions.py
438
+ β”‚Β Β  └── test_memory.py
439
+ β”œβ”€β”€ fixtures
440
+ β”‚Β Β  β”œβ”€β”€ dialogues
441
+ β”‚Β Β  β”‚Β Β  └── sample.json
442
+ β”‚Β Β  └── doctrine_snapshots
443
+ β”‚Β Β  └── sample.json
444
+ β”œβ”€β”€ test_agent.py
445
+ β”œβ”€β”€ test_ci_hooks.py
446
+ β”œβ”€β”€ test_evaluator.py
447
+ β”œβ”€β”€ test_integration.py
448
+ β”œβ”€β”€ test_orchestrator.py
449
+ β”œβ”€β”€ test_sandbox.py
450
+ β”œβ”€β”€ test_security.py
451
+ └── test_stress.py
452
+
453
+ 22 directories, 120 files
454
+ ```
455
 
456
  ---
457
 
 
504
  MkDocs documentation site
505
 
506
 
507
+ This completes the unified BLUX-cA kernel.